2026-10-09 17:13:57,482 - DEBUG - Parsing Test data successful
2026-10-09 17:13:57,483 - DEBUG - Payload: {'account': 'admin', 'command': 'listUsers', 'response': 'json'}
2026-10-09 17:13:57,483 - DEBUG - ========Sending GET Cmd : listUsers=======
2026-10-09 17:13:57,502 - DEBUG - Response : [{id : 'a672c44f-c3f0-11f1-975d-1e002100023e', username : 'admin', firstname : 'admin', lastname : 'cloud', created : '2026-10-09T14:49:37+0000', state : 'enabled', account : 'admin', accounttype : 1, usersource : 'native', roleid : '728a7b63-c3f0-11f1-975d-1e002100023e', roletype : 'Admin', rolename : 'Root Admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', apikey : 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', iscallerchilddomain : False, isdefault : True, is2faenabled : False, is2famandated : False, apikeyaccess : 'INHERIT'}]
2026-10-09 17:13:57,502 - DEBUG - Payload: {'id': 'a672c44f-c3f0-11f1-975d-1e002100023e', 'command': 'getUserKeys', 'response': 'json'}
2026-10-09 17:13:57,502 - DEBUG - ========Sending GET Cmd : getUserKeys=======
2026-10-09 17:13:57,515 - DEBUG - Response : {apikey : 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', secretkey : 'R6QPwRUz09TVXBjXNwZk7grTjcPtsFRphH6xhN1oPvnc12YUk296t4KHytg8zRLczDA0X5NsLVi4d8rfMMx3yg', apikeyaccess : True}
2026-10-09 17:13:57,515 - DEBUG - ==== Test Client Creation Successful ====
2026-10-09 17:13:57,527 - DEBUG - ::::::::::::STARTED : TC: test_default_role_deletion :::::::::::
2026-10-09 17:13:57,528 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:13:57,528 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:13:57,587 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:13:57,588 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role zj5qtqh0r8', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'kL1f38TODPEv/tjIiZcNHmjNbuI='}
2026-10-09 17:13:57,588 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:13:57,633 - DEBUG - Response : {type : 'User', state : 'enabled', id : '0c85f6e0-0259-4fdb-8fc6-981d14066f22', name : 'MarvinFake Role zj5qtqh0r8', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:13:57,633 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '0c85f6e0-0259-4fdb-8fc6-981d14066f22', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'14QPz4V1oNrBEl9iJLZ1zP+V8ZE='}
2026-10-09 17:13:57,633 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:13:57,681 - DEBUG - Response : {id : 'a13a1815-ce8d-4d71-9f44-f0208570d3fe', roleid : '0c85f6e0-0259-4fdb-8fc6-981d14066f22', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:13:57,682 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '0c85f6e0-0259-4fdb-8fc6-981d14066f22', 'username': 'rolete-TestDynamicRoles-test_default_role_deletion-O77KT2', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'jKDd+cgTIMv1Cutgmoz6Z/B1+EQ='}
2026-10-09 17:13:57,682 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:13:59,197 - DEBUG - Response : {id : '92464d83-c0c3-4f5d-aa43-6cec7e1fc8f4', name : 'rolete-TestDynamicRoles-test_default_role_deletion-O77KT2', accounttype : 0, roleid : '0c85f6e0-0259-4fdb-8fc6-981d14066f22', roletype : 'User', rolename : 'MarvinFake Role zj5qtqh0r8', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:13:58+0000', user : [{id : '46825b70-fb2e-4234-8d6b-c2f8b70e0014', username : 'rolete-TestDynamicRoles-test_default_role_deletion-O77KT2', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:13:59+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_default_role_deletion-O77KT2', accounttype : 0, usersource : 'native', roleid : '0c85f6e0-0259-4fdb-8fc6-981d14066f22', roletype : 'User', rolename : 'MarvinFake Role zj5qtqh0r8', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '92464d83-c0c3-4f5d-aa43-6cec7e1fc8f4', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:13:59,198 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:13:59,198 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:13:59,230 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:13:59,230 - DEBUG - Payload: {'id': 1, 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'9gomJ8+lw0mfshwNC2za8pIqEbo='}
2026-10-09 17:13:59,230 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:13:59,260 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted
2026-10-09 17:13:59,260 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRole.deleteRoleCmd object at 0x7f22470adeb0> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted
2026-10-09 17:13:59,260 - DEBUG - Payload: {'id': 2, 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Ft2MG6SmbvsD2b0u/IHPLyKzalE='}
2026-10-09 17:13:59,260 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:13:59,293 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted
2026-10-09 17:13:59,293 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRole.deleteRoleCmd object at 0x7f2247095340> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted
2026-10-09 17:13:59,293 - DEBUG - Payload: {'id': 3, 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'GUMFiKDoDbpwFxSWjG1ulfIxbrg='}
2026-10-09 17:13:59,293 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:13:59,323 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted
2026-10-09 17:13:59,324 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRole.deleteRoleCmd object at 0x7f22470adf40> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted
2026-10-09 17:13:59,324 - DEBUG - Payload: {'id': 4, 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'826sCLYM5ja9sR04EH+YkroSLxM='}
2026-10-09 17:13:59,324 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:13:59,356 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted
2026-10-09 17:13:59,357 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRole.deleteRoleCmd object at 0x7f2247095cd0> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Default roles cannot be deleted
2026-10-09 17:13:59,357 - DEBUG - Payload: {'id': '92464d83-c0c3-4f5d-aa43-6cec7e1fc8f4', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'yXDaL6LiYKDQyd/drTHPYihsEb8='}
2026-10-09 17:13:59,357 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:13:59,407 - DEBUG - === Jobid: b4da3932-305f-43f3-88d2-c346d89839f1 Started ===
2026-10-09 17:13:59,408 - DEBUG - Payload: {'jobid': 'b4da3932-305f-43f3-88d2-c346d89839f1', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'0LmulvZPNEtUjoortnNrBu9yp4E='}
2026-10-09 17:13:59,408 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:13:59,449 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '92464d83-c0c3-4f5d-aa43-6cec7e1fc8f4', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:13:59+0000', jobid : 'b4da3932-305f-43f3-88d2-c346d89839f1', jobstatus : 0}
2026-10-09 17:14:00,451 - DEBUG - === JobId:b4da3932-305f-43f3-88d2-c346d89839f1 is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:00,451 - DEBUG - Payload: {'jobid': 'b4da3932-305f-43f3-88d2-c346d89839f1', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'0LmulvZPNEtUjoortnNrBu9yp4E='}
2026-10-09 17:14:00,451 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:00,488 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '92464d83-c0c3-4f5d-aa43-6cec7e1fc8f4', created : '2026-10-09T17:13:59+0000', completed : '2026-10-09T17:13:59+0000', jobid : 'b4da3932-305f-43f3-88d2-c346d89839f1', jobstatus : 1}
2026-10-09 17:14:00,488 - DEBUG - ===Jobid:b4da3932-305f-43f3-88d2-c346d89839f1 ; StartTime:Fri Oct  9 17:13:59 2026 ; EndTime:Fri Oct  9 17:14:00 2026 ; TotalTime:-1===
2026-10-09 17:14:00,488 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '92464d83-c0c3-4f5d-aa43-6cec7e1fc8f4', created : '2026-10-09T17:13:59+0000', completed : '2026-10-09T17:13:59+0000', jobid : 'b4da3932-305f-43f3-88d2-c346d89839f1', jobstatus : 1}
2026-10-09 17:14:00,489 - DEBUG - Payload: {'id': 'a13a1815-ce8d-4d71-9f44-f0208570d3fe', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'khYfn7VZpxRNAD4fsMSbO68h2Fg='}
2026-10-09 17:14:00,490 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:00,532 - DEBUG - Response : {success : True}
2026-10-09 17:14:00,533 - DEBUG - Payload: {'id': '0c85f6e0-0259-4fdb-8fc6-981d14066f22', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'1geqetjjIBoTiaZJNOeVOVwfFyc='}
2026-10-09 17:14:00,533 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:00,570 - DEBUG - Response : {success : True}
2026-10-09 17:14:00,571 - DEBUG - TestCaseName: test_default_role_deletion; Time Taken: 3 Seconds; StartTime: Fri Oct  9 17:13:57 2026; EndTime: Fri Oct  9 17:14:00 2026; Result: SUCCESS
2026-10-09 17:14:00,571 - DEBUG - ::::::::::::STARTED : TC: test_role_account_acls :::::::::::
2026-10-09 17:14:00,571 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:00,571 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:00,616 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:00,617 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role me59if1hn5', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'OFFiwGJgvoepnubAeR0ZiuGfuno='}
2026-10-09 17:14:00,617 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:00,702 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'a7a204ab-fc30-405c-ab9e-577550a4ab20', name : 'MarvinFake Role me59if1hn5', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:00,702 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'a7a204ab-fc30-405c-ab9e-577550a4ab20', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'wwQxrb6zJHebH5oQppYbKM/P72Q='}
2026-10-09 17:14:00,702 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:00,749 - DEBUG - Response : {id : '7198a342-cffb-4424-9fbb-99537aee374e', roleid : 'a7a204ab-fc30-405c-ab9e-577550a4ab20', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:00,749 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': 'a7a204ab-fc30-405c-ab9e-577550a4ab20', 'username': 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ENQ9j1mN7AwfFZHm5MT6cUK5UTM='}
2026-10-09 17:14:00,750 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:14:02,147 - DEBUG - Response : {id : 'f6ffb457-2990-4712-8035-6fb9a43c9976', name : 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', accounttype : 0, roleid : 'a7a204ab-fc30-405c-ab9e-577550a4ab20', roletype : 'User', rolename : 'MarvinFake Role me59if1hn5', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:01+0000', user : [{id : '60eeff3a-166b-43cf-8c57-6300acb8313e', username : 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:02+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', accounttype : 0, usersource : 'native', roleid : 'a7a204ab-fc30-405c-ab9e-577550a4ab20', roletype : 'User', rolename : 'MarvinFake Role me59if1hn5', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : 'f6ffb457-2990-4712-8035-6fb9a43c9976', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:14:02,148 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:14:02,148 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:14:02,179 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:14:02,180 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'a7a204ab-fc30-405c-ab9e-577550a4ab20', 'rule': 'listApis', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'b0ie63u0FQviFfXIfCo6SzcYvvw='}
2026-10-09 17:14:02,180 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:02,220 - DEBUG - Response : {id : '54a63c22-18ac-4055-b1de-80be7ace436e', roleid : 'a7a204ab-fc30-405c-ab9e-577550a4ab20', rule : 'listApis', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:02,220 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'a7a204ab-fc30-405c-ab9e-577550a4ab20', 'rule': 'listAccounts', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'N5jjLdWow8MugjgEDlTEVea6h8I='}
2026-10-09 17:14:02,220 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:02,261 - DEBUG - Response : {id : '7f573bdd-de50-4452-918a-122dc920a99e', roleid : 'a7a204ab-fc30-405c-ab9e-577550a4ab20', rule : 'listAccounts', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:02,261 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'deny', 'roleid': 'a7a204ab-fc30-405c-ab9e-577550a4ab20', 'rule': 'listClusters', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'vIPjnxRFLxDwoeSpJ7LJPPCzSgI='}
2026-10-09 17:14:02,261 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:02,343 - DEBUG - Response : {id : '86d8b206-706b-4c06-bbd7-02574bd5735d', roleid : 'a7a204ab-fc30-405c-ab9e-577550a4ab20', rule : 'listClusters', permission : 'deny', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:02,343 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'a7a204ab-fc30-405c-ab9e-577550a4ab20', 'rule': '*VM*', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'6OTWvfqCugNAWJv/X0IJSSQSZYE='}
2026-10-09 17:14:02,343 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:02,383 - DEBUG - Response : {id : '9636a511-e284-4f06-affd-edd0e941c145', roleid : 'a7a204ab-fc30-405c-ab9e-577550a4ab20', rule : '*VM*', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:02,383 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'deny', 'roleid': 'a7a204ab-fc30-405c-ab9e-577550a4ab20', 'rule': '*Host*', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'p8AbDK/b/4NB8zb+VjRCjHxFlXc='}
2026-10-09 17:14:02,383 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:02,430 - DEBUG - Response : {id : 'f0773965-93c9-468a-a3fc-c97908eaa75d', roleid : 'a7a204ab-fc30-405c-ab9e-577550a4ab20', rule : '*Host*', permission : 'deny', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:07,436 - DEBUG - Payload: {'name': 'ROOT', 'command': 'listDomains', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'FUkLFPJq0p6AOaVYSkY//WIQFBk='}
2026-10-09 17:14:07,436 - DEBUG - ========Sending GET Cmd : listDomains=======
2026-10-09 17:14:07,477 - DEBUG - Response : [{id : '403e1dfc-c3f0-11f1-975d-1e002100023e', name : 'ROOT', level : 0, haschild : False, path : 'ROOT', state : 'Active', vmlimit : 'Unlimited', vmtotal : 0, vmavailable : 'Unlimited', iplimit : 'Unlimited', iptotal : 0, ipavailable : 'Unlimited', volumelimit : 'Unlimited', volumetotal : 2, volumeavailable : 'Unlimited', snapshotlimit : 'Unlimited', snapshottotal : 0, snapshotavailable : 'Unlimited', backuplimit : 'Unlimited', backuptotal : 0, backupavailable : 'Unlimited', backupstoragelimit : 'Unlimited', backupstoragetotal : 0, backupstorageavailable : 'Unlimited', templatelimit : 'Unlimited', templatetotal : 13, templateavailable : 'Unlimited', projectlimit : 'Unlimited', projecttotal : 0, projectavailable : 'Unlimited', networklimit : 'Unlimited', networktotal : 0, networkavailable : 'Unlimited', vpclimit : 'Unlimited', vpctotal : 0, vpcavailable : 'Unlimited', cpulimit : 'Unlimited', cputotal : 0, cpuavailable : 'Unlimited', memorylimit : 'Unlimited', memorytotal : 0, memoryavailable : 'Unlimited', gpulimit : 'Unlimited', gputotal : 0, gpuavailable : 'Unlimited', primarystoragelimit : 'Unlimited', primarystoragetotal : 9, primarystorageavailable : 'Unlimited', secondarystoragelimit : 'Unlimited', secondarystoragetotal : 13.067401, secondarystorageavailable : 'Unlimited', bucketlimit : 'Unlimited', buckettotal : 0, bucketavailable : 'Unlimited', objectstoragelimit : 'Unlimited', objectstoragetotal : 0, objectstorageavailable : 'Unlimited', hasannotations : False}]
2026-10-09 17:14:07,478 - DEBUG - Payload: {'listall': True, 'name': 'ROOT', 'command': 'listDomains', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'MTo4M/OsRVaY9H/KZqvgm9hNmEQ='}
2026-10-09 17:14:07,478 - DEBUG - ========Sending GET Cmd : listDomains=======
2026-10-09 17:14:07,509 - DEBUG - Response : [{id : '403e1dfc-c3f0-11f1-975d-1e002100023e', name : 'ROOT', level : 0, haschild : False, path : 'ROOT', state : 'Active', vmlimit : 'Unlimited', vmtotal : 0, vmavailable : 'Unlimited', iplimit : 'Unlimited', iptotal : 0, ipavailable : 'Unlimited', volumelimit : 'Unlimited', volumetotal : 2, volumeavailable : 'Unlimited', snapshotlimit : 'Unlimited', snapshottotal : 0, snapshotavailable : 'Unlimited', backuplimit : 'Unlimited', backuptotal : 0, backupavailable : 'Unlimited', backupstoragelimit : 'Unlimited', backupstoragetotal : 0, backupstorageavailable : 'Unlimited', templatelimit : 'Unlimited', templatetotal : 13, templateavailable : 'Unlimited', projectlimit : 'Unlimited', projecttotal : 0, projectavailable : 'Unlimited', networklimit : 'Unlimited', networktotal : 0, networkavailable : 'Unlimited', vpclimit : 'Unlimited', vpctotal : 0, vpcavailable : 'Unlimited', cpulimit : 'Unlimited', cputotal : 0, cpuavailable : 'Unlimited', memorylimit : 'Unlimited', memorytotal : 0, memoryavailable : 'Unlimited', gpulimit : 'Unlimited', gputotal : 0, gpuavailable : 'Unlimited', primarystoragelimit : 'Unlimited', primarystoragetotal : 9, primarystorageavailable : 'Unlimited', secondarystoragelimit : 'Unlimited', secondarystoragetotal : 13.067401, secondarystorageavailable : 'Unlimited', bucketlimit : 'Unlimited', buckettotal : 0, bucketavailable : 'Unlimited', objectstoragelimit : 'Unlimited', objectstoragetotal : 0, objectstorageavailable : 'Unlimited', hasannotations : False}]
2026-10-09 17:14:07,510 - DEBUG - Payload: {'domainid': '403e1dfc-c3f0-11f1-975d-1e002100023e', 'listall': True, 'name': 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', 'command': 'listAccounts', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'FRGEUILua3zCCXVamnK/8AqyiGw='}
2026-10-09 17:14:07,510 - DEBUG - ========Sending GET Cmd : listAccounts=======
2026-10-09 17:14:07,575 - DEBUG - Response : [{id : 'f6ffb457-2990-4712-8035-6fb9a43c9976', name : 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', accounttype : 0, roleid : 'a7a204ab-fc30-405c-ab9e-577550a4ab20', roletype : 'User', rolename : 'MarvinFake Role me59if1hn5', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:01+0000', user : [{id : '60eeff3a-166b-43cf-8c57-6300acb8313e', username : 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:02+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', accounttype : 0, usersource : 'native', roleid : 'a7a204ab-fc30-405c-ab9e-577550a4ab20', roletype : 'User', rolename : 'MarvinFake Role me59if1hn5', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : 'f6ffb457-2990-4712-8035-6fb9a43c9976', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}]
2026-10-09 17:14:07,575 - DEBUG - Payload: {'domainid': '403e1dfc-c3f0-11f1-975d-1e002100023e', 'listall': True, 'username': 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', 'command': 'listUsers', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ClDdNN7TJ7018mPYaQr8AVCPlYo='}
2026-10-09 17:14:07,575 - DEBUG - ========Sending GET Cmd : listUsers=======
2026-10-09 17:14:07,606 - DEBUG - Response : [{id : '60eeff3a-166b-43cf-8c57-6300acb8313e', username : 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:02+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', accounttype : 0, usersource : 'native', roleid : 'a7a204ab-fc30-405c-ab9e-577550a4ab20', roletype : 'User', rolename : 'MarvinFake Role me59if1hn5', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : 'f6ffb457-2990-4712-8035-6fb9a43c9976', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False, apikeyaccess : 'INHERIT'}]
2026-10-09 17:14:07,607 - DEBUG - Payload: {'id': '60eeff3a-166b-43cf-8c57-6300acb8313e', 'command': 'getUserKeys', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ZEmNwIdhj96+ITNtMMKlvSmDKO0='}
2026-10-09 17:14:07,607 - DEBUG - ========Sending GET Cmd : getUserKeys=======
2026-10-09 17:14:07,631 - DEBUG - Response : {apikeyaccess : True}
2026-10-09 17:14:07,631 - ERROR - __createApiClient: API Client Creation Failed
2026-10-09 17:14:07,632 - DEBUG - Payload: {'id': '60eeff3a-166b-43cf-8c57-6300acb8313e', 'name': 'keypair-60eeff3a-166b-43cf-8c57-6300acb8313e', 'command': 'registerUserKeys', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'92ELh6vgIDcsax0MdPsE81e/0rM='}
2026-10-09 17:14:07,632 - DEBUG - ========Sending GET Cmd : registerUserKeys=======
2026-10-09 17:14:09,243 - DEBUG - Response : {name : 'keypair-60eeff3a-166b-43cf-8c57-6300acb8313e', apikey : 'YGafIaYkUwKooQFjAjiwBU04J8aingJtZf2EaKJU6Xj1Cc787jyQgRhOVatBx7CfickiHZvktjYKFlcroO_cgQ', secretkey : 'wJdBta8belLvP8PDy7jT5VYkZBGyLb7htuTz5cOfrN1wuexR-bIKWoZyztirdEaObbJuaL7zR694R7UpeNXqoQ', userid : '60eeff3a-166b-43cf-8c57-6300acb8313e', username : 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', id : 'e9524204-13ed-48fd-98f5-3876d2448902', created : '2026-10-09T17:14:09+0000', accounttype : 'NORMAL', accountid : 'f6ffb457-2990-4712-8035-6fb9a43c9976', accountname : 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', roleid : 'a7a204ab-fc30-405c-ab9e-577550a4ab20', roletype : 'User', rolename : 'MarvinFake Role me59if1hn5', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', state : 'ENABLED'}
2026-10-09 17:14:09,244 - DEBUG - Payload: {'id': '60eeff3a-166b-43cf-8c57-6300acb8313e', 'command': 'getUserKeys', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ZEmNwIdhj96+ITNtMMKlvSmDKO0='}
2026-10-09 17:14:09,244 - DEBUG - ========Sending GET Cmd : getUserKeys=======
2026-10-09 17:14:09,466 - DEBUG - Response : {apikey : 'YGafIaYkUwKooQFjAjiwBU04J8aingJtZf2EaKJU6Xj1Cc787jyQgRhOVatBx7CfickiHZvktjYKFlcroO_cgQ', secretkey : 'wJdBta8belLvP8PDy7jT5VYkZBGyLb7htuTz5cOfrN1wuexR-bIKWoZyztirdEaObbJuaL7zR694R7UpeNXqoQ', apikeyaccess : True}
2026-10-09 17:14:09,466 - DEBUG - Payload: {'command': 'listApis', 'response': 'json', 'apiKey': 'YGafIaYkUwKooQFjAjiwBU04J8aingJtZf2EaKJU6Xj1Cc787jyQgRhOVatBx7CfickiHZvktjYKFlcroO_cgQ', 'signature': b'qIfddM05jhi1yM3/GNE5v1ZEZVc='}
2026-10-09 17:14:09,466 - DEBUG - ========Sending GET Cmd : listApis=======
2026-10-09 17:14:09,989 - DEBUG - Response : [{name : 'deleteAutoScaleVmProfile', description : 'Deletes a autoscale Instance profile.', isasync : True, params : [{name : 'id', description : 'The ID of the autoscale profile', type : 'uuid', length : 255, required : True, related : 'createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'deleteKMSKey', description : 'Deletes a KMS key (only if not in use)', since : '4.23.0', isasync : True, params : [{name : 'id', description : 'The UUID of the KMS key to delete', type : 'uuid', length : 255, required : True, related : 'listKMSKeys,createKMSKey,updateKMSKey'}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'rebootSystemVm', description : 'Reboots a system VM.', isasync : True, related : 'destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm', params : [{name : 'id', description : 'The ID of the System VM', type : 'uuid', length : 255, required : True, related : 'destroySystemVm,listSystemVms,migrateSystemVm,rebootSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm'}, {name : 'forced', description : 'Force reboot the System VM (System VM is Stopped and then Started)', type : 'boolean', length : 255, required : False, since : '4.16.0'}], response : [{name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}], httprequesttype : 'POST'}, {name : 'removeNodesFromKubernetesCluster', description : 'Removes external nodes from a CKS cluster. ', since : '4.21.0', isasync : True, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'id', description : 'the ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster,removeNodesFromKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {name : 'nodeids', description : 'comma separated list of node (physical or virtual machines) IDs that need to beremoved from the Kubernetes cluster (CKS)', type : 'list', length : 255, required : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}], response : [{name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}], httprequesttype : 'POST'}, {name : 'listOauthProvider', description : 'List OAuth providers registered', since : '4.19.0', isasync : False, related : 'verifyOAuthCodeAndGetUser,updateOauthProvider', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'provider', description : 'Name of the provider', type : 'string', length : 255, required : False}, {name : 'id', description : 'the ID of the OAuth provider', type : 'uuid', length : 255, required : False, related : 'listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'domainid', description : 'Domain ID to list OAuth providers for a specific domain. Use -1 for global providers only.', type : 'uuid', length : 255, required : False, since : '4.23.0', related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'domain', description : 'Domain path for domain-specific OAuth provider lookup. Ignored when Domain ID is passed.', type : 'string', length : 255, required : False, since : '4.23.0'}], response : [{name : 'id', description : 'ID of the provider', type : 'string'}, {name : 'redirecturi', description : 'Redirect URI registered in the OAuth provider', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'clientid', description : 'Client ID registered in the OAuth provider', type : 'string'}, {name : 'authorizeurl', description : 'Authorize URL registered in the OAuth provider', type : 'string'}, {}, {name : 'tokenurl', description : 'Token URL registered in the OAuth provider', type : 'string'}, {name : 'domain', description : 'name of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'provider', description : 'Name of the provider', type : 'string'}, {name : 'domainpath', description : 'path of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'enabled', description : 'Whether the OAuth provider is enabled or not', type : 'boolean'}, {}, {name : 'domainid', description : 'UUID of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'secretkey', description : 'Secret key registered in the OAuth provider', type : 'string'}, {name : 'name', description : 'Name of the provider', type : 'string'}, {name : 'description', description : 'Description of the provider registered', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'updateSharedFileSystem', description : 'Update a Shared FileSystem', since : '4.20.0', isasync : False, related : 'createSharedFileSystem,listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering', params : [{name : 'description', description : 'the description for the shared filesystem.', type : 'string', length : 255, required : False}, {name : 'name', description : 'the name of the shared filesystem.', type : 'string', length : 255, required : False}, {name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'createSharedFileSystem,listSharedFileSystems,updateSharedFileSystem,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}], response : [{name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}]}, {}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}], httprequesttype : 'POST'}, {name : 'destroySystemVm', description : 'Destroys a System VM.', isasync : True, related : 'listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm', params : [{name : 'id', description : 'The ID of the System VM', type : 'uuid', length : 255, required : True, related : 'destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm'}], response : [{name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}], httprequesttype : 'POST'}, {name : 'listASNumbers', description : 'List Autonomous Systems Numbers', since : '4.20.0', isasync : False, related : '', params : [{name : 'networkid', description : 'the network id', type : 'uuid', length : 255, required : False, related : 'createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'vpcid', description : 'the vpc id', type : 'uuid', length : 255, required : False, related : 'createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC'}, {name : 'domainid', description : 'domain id', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'asnrangeid', description : 'the AS Number range ID', type : 'uuid', length : 255, required : False, related : 'createASNRange,listASNRanges'}, {name : 'account', description : 'account name', type : 'string', length : 255, required : False, related : 'createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts'}, {name : 'asnumber', description : 'AS number', type : 'integer', length : 255, required : False, related : 'listASNumbers'}, {name : 'isallocated', description : 'to indicate if the AS number is allocated to any network', type : 'boolean', length : 255, required : False}], response : [{name : 'allocated', description : 'Allocated Date', type : 'date'}, {name : 'domain', description : 'the domain name', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'associatednetworkid', description : 'Network ID', type : 'string'}, {name : 'zonename', description : 'the zone name of the AS Number range', type : 'string'}, {name : 'associatednetworkname', description : 'Network Name', type : 'string'}, {name : 'asnumber', description : 'AS Number', type : 'long'}, {name : 'vpcname', description : 'VPC Name', type : 'string'}, {name : 'domainid', description : 'Domain ID', type : 'string'}, {name : 'id', description : 'ID of the AS Number', type : 'string'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'created', description : 'Created Date', type : 'date'}, {name : 'asnrangeid', description : 'AS Number ID', type : 'string'}, {name : 'allocationstate', description : 'Allocation state', type : 'string'}, {name : 'accountid', description : 'Account ID', type : 'string'}, {name : 'vpcid', description : 'VPC ID', type : 'string'}, {name : 'asnrange', description : 'AS Number Range', type : 'string'}, {}], httprequesttype : 'GET'}, {name : 'listUserData', description : 'List registered userdatas', since : '4.18', isasync : False, related : 'listCniConfiguration', params : [{name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'name', description : 'Userdata name to look for', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the Userdata', type : 'uuid', length : 255, required : False, related : 'listUserData,listCniConfiguration'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}], response : [{name : 'project', description : 'The project name of the User Data', type : 'string'}, {}, {name : 'accountid', description : 'The owner id of the User Data', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'params', description : 'List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in the User Data', type : 'string'}, {name : 'domain', description : 'The domain name of the User Data owner', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'id', description : 'ID of the User Data', type : 'string'}, {name : 'domainid', description : 'The domain id of the User Data owner', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'projectid', description : 'The project id of the User Data', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the User Data owner belongs', type : 'string'}, {name : 'account', description : 'The owner of the User Data', type : 'string'}, {name : 'name', description : 'Name of the User Data', type : 'string'}, {name : 'userdata', description : 'Base64 encoded User Data content', type : 'string'}], httprequesttype : 'GET'}, {name : 'scaleSystemVm', description : 'Scale the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect.', isasync : True, related : 'listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm', params : [{name : 'serviceofferingid', description : 'The service offering ID to apply to the system vm', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,cloneServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'details', description : 'Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value', type : 'map', length : 255, required : False}, {name : 'id', description : 'The ID of the system vm', type : 'uuid', length : 255, required : True, related : 'listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm'}], response : [{}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}], httprequesttype : 'POST'}, {name : 'verifyOAuthCodeAndGetUser', description : 'Verify the OAuth Code and fetch the corresponding user from provider', since : '4.19.0', isasync : False, related : 'updateOauthProvider', params : [{name : 'secretcode', description : 'Code that is provided by OAuth provider (Eg. google, github) after successful login', type : 'string', length : 255, required : False}, {name : 'provider', description : 'Name of the provider', type : 'string', length : 255, required : True}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'domain', description : 'Domain path for domain-specific OAuth provider lookup. Ignored when Domain ID is passed.', type : 'string', length : 255, required : False, since : '4.23.0'}, {name : 'domainid', description : 'Domain ID for domain-specific OAuth provider lookup. If not provided, uses global provider', type : 'uuid', length : 255, required : False, since : '4.23.0', related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}], response : [{name : 'domainpath', description : 'path of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'id', description : 'ID of the provider', type : 'string'}, {name : 'domainid', description : 'UUID of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'secretkey', description : 'Secret key registered in the OAuth provider', type : 'string'}, {}, {name : 'redirecturi', description : 'Redirect URI registered in the OAuth provider', type : 'string'}, {name : 'tokenurl', description : 'Token URL registered in the OAuth provider', type : 'string'}, {name : 'authorizeurl', description : 'Authorize URL registered in the OAuth provider', type : 'string'}, {name : 'domain', description : 'name of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'description', description : 'Description of the provider registered', type : 'string'}, {name : 'provider', description : 'Name of the provider', type : 'string'}, {name : 'clientid', description : 'Client ID registered in the OAuth provider', type : 'string'}, {name : 'name', description : 'Name of the provider', type : 'string'}, {name : 'enabled', description : 'Whether the OAuth provider is enabled or not', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], httprequesttype : 'GET'}, {name : 'createBackupSchedule', description : 'Creates a User-defined Instance backup schedule', since : '4.14.0', isasync : False, related : 'listBackupSchedule', params : [{name : 'virtualmachineid', description : 'ID of the Instance for which schedule is to be defined', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'isolated', description : 'Whether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.', type : 'boolean', length : 255, required : False, since : '4.23.0'}, {name : 'timezone', description : 'Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.', type : 'string', length : 255, required : True}, {name : 'maxbackups', description : 'The maximum number of backups to keep for a VM. If "0", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.', type : 'integer', length : 255, required : False, since : '4.21.0'}, {name : 'quiescevm', description : 'Quiesce the Instance before checkpointing the disks for backup. Applicable only to NAS and KBOSS backup providers. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'schedule', description : 'Custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28)', type : 'string', length : 255, required : True}, {name : 'intervaltype', description : 'Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY', type : 'string', length : 255, required : True}], response : [{name : 'quiescevm', description : 'quiesce the instance before checkpointing the disks for backup', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {name : 'schedule', description : 'The time the backup is scheduled to be taken.', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'maxbackups', description : 'maximum number of backups retained', type : 'integer'}, {name : 'id', description : 'ID of the backup schedule.', type : 'string'}, {name : 'isolated', description : 'Whether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.', type : 'boolean'}, {}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'timezone', description : 'The time zone of the backup schedule', type : 'string'}, {name : 'intervaltype', description : 'The interval type of the backup schedule', type : 'intervaltype'}, {}], httprequesttype : 'POST'}, {name : 'listKMSKeys', description : 'Lists KMS keys available to the caller', since : '4.23.0', isasync : False, related : 'createKMSKey,updateKMSKey', params : [{name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'enabled', description : 'Filter by enabled status', type : 'boolean', length : 255, required : False}, {name : 'hsmprofileid', description : 'Filter by HSM profile ID', type : 'uuid', length : 255, required : False, related : 'createHSMProfile,listHSMProfiles,updateHSMProfile'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'List KMS key by UUID', type : 'uuid', length : 255, required : False, related : 'listKMSKeys,createKMSKey,updateKMSKey'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'zoneid', description : 'Filter by zone ID', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}], response : [{name : 'domain', description : 'the domain name of the key', type : 'string'}, {name : 'created', description : 'the creation timestamp', type : 'date'}, {name : 'name', description : 'the name of the key', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'the UUID of the key', type : 'string'}, {name : 'project', description : 'the project name of the key', type : 'string'}, {name : 'enabled', description : 'whether the key is enabled', type : 'boolean'}, {name : 'description', description : 'the description of the key', type : 'string'}, {name : 'accountid', description : 'the account ID owning the key', type : 'string'}, {name : 'zoneid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'domainid', description : 'the domain ID of the key', type : 'string'}, {}, {name : 'domainpath', description : 'the domain path of the key', type : 'string'}, {name : 'hsmprofileid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'account', description : 'the account owning the key', type : 'string'}, {name : 'keybits', description : 'the key size in bits', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zonename', description : 'the zone name where the key is valid', type : 'string'}, {name : 'projectid', description : 'the project ID of the key', type : 'string'}, {}, {name : 'version', description : 'the key size in bits', type : 'integer'}, {name : 'keklabel', description : 'the provider-specific KEK label (admin only)', type : 'string'}, {name : 'algorithm', description : 'the encryption algorithm', type : 'string'}, {name : 'hsmprofile', description : 'the zone name where the key is valid', type : 'string'}], httprequesttype : 'GET'}, {name : 'cleanVMReservations', description : 'Cleanups Instance reservations in the database.', isasync : True, params : [], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'updateRoutingFirewallRule', description : 'Updates Routing firewall rule with specified ID', since : '4.20.0', isasync : True, related : 'createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules', params : [{name : 'id', description : 'the ID of the Routing firewall rule', type : 'uuid', length : 255, required : True, related : 'createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules'}, {name : 'customid', description : 'An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only', type : 'string', length : 255, required : False, since : '4.4'}, {name : 'fordisplay', description : 'an optional field, whether to the display the Routing firewall rule to the end user or not', type : 'boolean', length : 255, required : False}], response : [{name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {name : 'privateport', description : "The starting port of port forwarding rule's private port range", type : 'string'}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}, {name : 'privateendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {}, {name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {name : 'virtualmachinedisplayname', description : 'The Instance display name for the port forwarding rule', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'list', response : [{name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {name : 'state', description : 'The state of the rule', type : 'string'}, {}, {name : 'networkid', description : 'The ID of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'id', description : 'The ID of the port forwarding rule', type : 'string'}, {name : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', type : 'string'}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID for the port forwarding rule', type : 'string'}, {name : 'publicport', description : "The starting port of port forwarding rule's public port range", type : 'string'}, {name : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listObjectStoragePools', description : 'Lists object storage pools.', since : '4.19.0', isasync : False, related : 'addObjectStoragePool,updateObjectStoragePool', params : [{name : 'id', description : 'the ID of the storage pool', type : 'uuid', length : 255, required : False, related : 'addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool'}, {name : 'name', description : 'the name of the object store', type : 'string', length : 255, required : False}, {name : 'provider', description : 'the object store provider', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'url', description : 'the url of the object store', type : 'string'}, {}, {name : 'name', description : 'the name of the object store', type : 'string'}, {name : 'storageallocated', description : 'the allocated size of the object store', type : 'long'}, {name : 'storagetotal', description : 'the total size of the object store', type : 'long'}, {name : 'id', description : 'the ID of the object store', type : 'string'}, {name : 'storageused', description : 'the object store currently used size', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'providername', description : 'the provider name of the object store', type : 'string'}, {}], httprequesttype : 'GET'}, {name : 'removeVmwareDc', description : 'Remove a VMware datacenter from a zone.', isasync : False, params : [{name : 'zoneid', description : 'The id of Zone from which VMware datacenter has to be removed.', type : 'uuid', length : 255, required : True, related : 'createZone,updateZone,listZones,listZones'}], response : [{}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'runCustomAction', description : 'Run the custom action', since : '4.21.0', isasync : True, related : '', params : [{name : 'resourceid', description : 'ID of the instance', type : 'string', length : 255, required : True}, {name : 'customactionid', description : 'ID of the custom action', type : 'uuid', length : 255, required : True, related : 'addCustomAction,listCustomActions'}, {name : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : False}, {name : 'parameters', description : 'Parameters in key/value pairs using format parameters[i].keyname=keyvalue. Example: parameters[0].endpoint.url=urlvalue', type : 'map', length : 255, required : False}], response : [{name : 'id', description : 'ID of the action', type : 'string'}, {name : 'success', description : 'Whether custom action succeed or not', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'name', description : 'Name of the action', type : 'string'}, {name : 'result', description : 'Result of the action execution', type : 'map'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listDnsRecords', description : 'Lists DNS records from the external provider', since : '4.23.0', isasync : False, related : 'createDnsRecord', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'dnszoneid', description : 'ID of the DNS zone to list records from', type : 'uuid', length : 255, required : True, related : 'createDnsZone,listDnsZones,updateDnsZone'}], response : [{}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'contents', description : 'The contents of the record (IP address or target)', type : 'list'}, {name : 'name', description : 'The record name (e.g., www.example.com.)', type : 'string'}, {name : 'type', description : 'The record type (e.g., A, CNAME, TXT)', type : 'recordtype'}, {name : 'ttl', description : 'Time to live (TTL) in seconds', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'createBackup', description : 'Create Instance backup', since : '4.14.0', isasync : True, params : [{name : 'virtualmachineid', description : 'ID of the Instance', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'description', description : 'the description for the backup', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'quiescevm', description : 'Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS and KBOSS backup providers. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'isolated', description : 'Whether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.', type : 'boolean', length : 255, required : False, since : '4.23.0'}, {name : 'name', description : 'the name of the backup', type : 'string', length : 255, required : False, since : '4.21.0'}], response : [{}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'listIpv6FirewallRules', description : 'Lists all IPv6 firewall rules', isasync : False, related : 'createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules', params : [{name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'fordisplay', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'id', description : 'Lists IPv6 firewall rule with the specified ID', type : 'uuid', length : 255, required : False, related : 'createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'networkid', description : 'List IPV6 firewall rules by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'traffictype', description : 'List IPV6 firewall rules by traffic type - ingress or egress', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}], response : [{name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {name : 'state', description : 'The state of the rule', type : 'string'}, {name : 'networkid', description : 'The ID of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {}, {name : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}, {name : 'id', description : 'The ID of the port forwarding rule', type : 'string'}, {name : 'publicport', description : "The starting port of port forwarding rule's public port range", type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID for the port forwarding rule', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {name : 'privateendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {}, {name : 'privateport', description : "The starting port of port forwarding rule's private port range", type : 'string'}, {name : 'virtualmachinedisplayname', description : 'The Instance display name for the port forwarding rule', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'list', response : [{name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}], httprequesttype : 'GET'}, {name : 'stopSystemVm', description : 'Stops a system VM.', isasync : True, related : 'listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm', params : [{name : 'forced', description : 'Force stop the Instance (Instance is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the Instance is stopped and should be marked as such.', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The ID of the System VM', type : 'uuid', length : 255, required : True, related : 'listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm'}], response : [{name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}], httprequesttype : 'POST'}, {name : 'listVMSchedule', description : 'List Instance Schedules.', since : '4.19.0', isasync : False, related : 'createVMSchedule,updateVMSchedule', params : [{name : 'action', description : 'Action taken by schedule', type : 'string', length : 255, required : False}, {name : 'enabled', description : 'Filter by enabled status', type : 'boolean', length : 255, required : False}, {name : 'virtualmachineid', description : 'ID of the Instance for which schedule is to be defined', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'ID of Instance schedule', type : 'uuid', length : 255, required : False, related : 'createVMSchedule,listVMSchedule,updateVMSchedule'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'virtualmachineid', description : 'ID of Instance', type : 'string'}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'action', description : 'Action', type : 'action'}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'description', description : 'Description of Instance schedule', type : 'string'}, {}, {name : 'enabled', description : 'VM schedule is enabled', type : 'boolean'}, {name : 'schedule', description : 'Cron formatted Instance schedule', type : 'string'}, {}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'id', description : 'The ID of Instance schedule', type : 'string'}], httprequesttype : 'GET'}, {name : 'patchSystemVm', description : 'Attempts to live patch systemVMs - CPVM, SSVM ', since : '4.17.0', isasync : True, params : [{name : 'forced', description : 'If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'Patches System VM - CPVM/SSVM with the specified ID', type : 'uuid', length : 255, required : False, related : 'listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm'}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {}], httprequesttype : 'POST'}, {name : 'addNodesToKubernetesCluster', description : 'Add nodes as workers to an existing CKS cluster. ', since : '4.21.0', isasync : True, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'nodeids', description : 'comma separated list of (external) node (physical or virtual machines) IDs that need to beadded as worker nodes to an existing managed Kubernetes cluster (CKS)', type : 'list', length : 255, required : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'mountcksisoonvr', description : '(optional) Vmware only, uses the CKS cluster network VR to mount the CKS ISO', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'the ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, since : '4.21.0', related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {name : 'manualupgrade', description : '(optional) indicates if the node is marked for manual upgrade and excluded from the Kubernetes cluster upgrade operation', type : 'boolean', length : 255, required : False}], response : [{name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}], httprequesttype : 'POST'}, {name : 'listVolumesMetrics', description : 'Lists volume metrics', since : '4.9.3', isasync : False, related : '', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'isencrypted', description : 'list only volumes that are encrypted', type : 'boolean', length : 255, required : False, since : '4.19.1'}, {name : 'serviceofferingid', description : 'List volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored', type : 'uuid', length : 255, required : False, since : '4.19.1', related : 'createServiceOffering,cloneServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the disk volume', type : 'uuid', length : 255, required : False, related : 'attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}, {name : 'virtualmachineid', description : 'The ID of the Instance', type : 'uuid', length : 255, required : False, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'podid', description : 'The pod ID the disk volume belongs to', type : 'uuid', length : 255, required : False, related : 'createPod,listPods,updatePod,createManagementNetworkIpRange'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'listsystemvms', description : 'List system VMs; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.18'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'ids', description : 'The IDs of the volumes, mutually exclusive with id', type : 'list', length : 255, required : False, since : '4.9', related : 'attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}, {name : 'diskofferingid', description : 'List volumes by disk offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'createDiskOffering,cloneDiskOffering,updateDiskOffering,listDiskOfferings'}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", type : 'boolean', length : 255, required : False}, {name : 'storageid', description : 'The ID of the storage pool, available to ROOT admin only', type : 'string', length : 255, required : False, since : '4.3', related : 'cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}, {name : 'type', description : 'The type of disk volume', type : 'string', length : 255, required : False}, {name : 'clusterid', description : 'The cluster ID the disk volume belongs to', type : 'uuid', length : 255, required : False, related : 'addCluster,updateCluster'}, {name : 'name', description : 'The name of the disk volume', type : 'string', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'kmskeyid', description : 'List volumes by KMS Key', type : 'uuid', length : 255, required : False, since : '4.23', related : 'createKMSKey,updateKMSKey'}, {name : 'zoneid', description : 'The ID of the availability zone', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'hostid', description : 'List volumes on specified host', type : 'uuid', length : 255, required : False, related : 'addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost'}, {name : 'displayvolume', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'state', description : 'State of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.', type : 'string', length : 255, required : False}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}], response : [{name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'vmstate', description : 'State of the Instance', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'diskiopstotal', description : 'The total disk iops', type : 'long'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'sizegb', description : 'Disk size in GiB', type : 'string'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'deviceid', description : 'The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.', type : 'long'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {name : 'path', description : 'The path of the volume', type : 'string'}], httprequesttype : 'GET'}, {name : 'listDetailOptions', description : 'Lists all possible details and their options for a resource type such as an Instance or a Template', since : '4.13', isasync : False, related : '', params : [{name : 'resourceid', description : 'The UUID of the resource (optional)', type : 'string', length : 255, required : False}, {name : 'resourcetype', description : 'The resource type such as UserVm, Template etc.', type : 'string', length : 255, required : True}], response : [{}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'details', description : 'Map of all possible details and their possible list of values', type : 'map'}], httprequesttype : 'GET'}, {name : 'updateVmNicIp', description : 'Update the default IP of an Instance NIC', isasync : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm', params : [{name : 'ipaddress', description : 'Secondary IP Address', type : 'string', length : 255, required : False}, {name : 'nicid', description : 'The ID of the NIC to which you want to assign private IP', type : 'uuid', length : 255, required : True, related : 'updateVmNic,listNics'}], response : [{name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}]}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}]}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}]}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'description', description : 'The description of the security group', type : 'string'}]}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}]}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}, {name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'name', description : 'The name of the attached ISO', type : 'string'}]}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}], httprequesttype : 'POST'}, {name : 'startInternalLoadBalancerVM', description : 'Starts an existing Internal LB Instance.', isasync : True, related : 'destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx', params : [{name : 'id', description : 'The ID of the Internal LB Instance', type : 'uuid', length : 255, required : True, related : 'destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx'}], response : [{name : 'hostid', description : 'The host ID for the router', type : 'string'}, {name : 'hostname', description : 'The hostname for the router', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the router', type : 'string'}, {name : 'created', description : 'The date and time the router was created', type : 'date'}, {name : 'publicnetworkid', description : 'The ID of the corresponding public Network', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the router', type : 'string'}, {name : 'guestnetworkname', description : 'The name of the corresponding guest Network', type : 'string'}, {name : 'version', description : 'The version of Template', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the router', type : 'string'}, {name : 'podname', description : 'The Pod name for the router', type : 'string'}, {name : 'state', description : 'The state of the router', type : 'state'}, {name : 'guestipaddress', description : 'The guest IP address for the router', type : 'string'}, {}, {name : 'name', description : 'The name of the router', type : 'string'}, {name : 'role', description : 'Role of the domain router', type : 'string'}, {name : 'id', description : 'The ID of the router', type : 'string'}, {name : 'softwareversion', description : 'The version of the code / software in the router', type : 'string'}, {name : 'redundantstate', description : 'The state of redundant virtual router', type : 'string'}, {name : 'domain', description : 'The domain associated with the router', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'gateway', description : 'The gateway for the router', type : 'string'}, {name : 'podid', description : 'The Pod ID for the router', type : 'string'}, {name : 'guestmacaddress', description : 'The guest MAC address for the router', type : 'string'}, {name : 'requiresupgrade', description : 'True if the router Template requires upgrade', type : 'boolean'}, {name : 'arch', description : 'CPU arch of the router', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the router belongs to', type : 'string'}, {}, {name : 'templateid', description : 'The Template ID for the router', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with the router', type : 'set', response : [{name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}]}, {name : 'zonename', description : 'The Zone name for the router', type : 'string'}, {name : 'isredundantrouter', description : 'If this router is an redundant virtual router', type : 'boolean'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'healthcheckresults', description : 'Last executed health check result for the router', type : 'list', response : [{name : 'checktype', description : 'The type of the health check - basic or advanced', type : 'string'}, {name : 'success', description : 'The result of the health check if available', type : 'boolean'}, {name : 'lastupdated', description : 'The date this VPC was created', type : 'date'}, {name : 'details', description : 'Detailed response generated on running health check', type : 'string'}, {name : 'checkname', description : 'The name of the health check on the router', type : 'string'}, {name : 'status', description : 'the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}', type : 'routerhealthstatus'}]}, {name : 'ip6dns1', description : 'The first IPv6 DNS for the router', type : 'string'}, {name : 'templatename', description : 'The Template name for the router', type : 'string'}, {name : 'guestnetworkid', description : 'The ID of the corresponding guest Network', type : 'string'}, {name : 'domainid', description : 'The domain ID associated with the router', type : 'string'}, {name : 'vpcid', description : 'VPC the router belongs to', type : 'string'}, {name : 'scriptsversion', description : 'The version of scripts', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'dns1', description : 'The first DNS for the router', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the router', type : 'string'}, {name : 'account', description : 'The Account associated with the router', type : 'string'}, {name : 'healthchecksfailed', description : 'True if any health checks had failed', type : 'boolean'}, {name : 'guestnetmask', description : 'The guest netmask for the router', type : 'string'}, {name : 'linklocalnetworkid', description : 'The ID of the corresponding link local Network', type : 'string'}, {name : 'project', description : 'The project name of the address', type : 'string'}, {name : 'dns2', description : 'The second DNS for the router', type : 'string'}, {name : 'vpcname', description : 'The name of VPC the router belongs to', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the router', type : 'string'}, {name : 'publicip', description : 'The public IP address for the router', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the router', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the router', type : 'string'}, {name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {name : 'ip6dns2', description : 'The second IPv6 DNS for the router', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the router', type : 'string'}], httprequesttype : 'POST'}, {name : 'removeVirtualMachinesFromKubernetesCluster', description : 'Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.', since : '4.19.0', isasync : False, related : '', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'virtualmachineids', description : 'The IDs of the VMs to remove from the cluster', type : 'list', length : 255, required : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}], httprequesttype : 'POST'}, {name : 'listKubernetesClusters', description : 'Lists Kubernetes clusters', isasync : False, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'clustertype', description : 'Type of the cluster: CloudManaged, ExternalManaged', type : 'string', length : 255, required : False, since : '4.19.0'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : False, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {name : 'name', description : 'Name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'state', description : 'State of the Kubernetes cluster', type : 'string', length : 255, required : False}], response : [{name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'createAutoScaleVmGroup', description : 'Creates and automatically starts an Instance based on a service offering, disk offering, and Template.', isasync : True, related : 'disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup', params : [{name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'uuid', length : 255, required : True, related : 'createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile'}, {name : 'scaleuppolicyids', description : 'List of scaleup autoscale policies', type : 'list', length : 255, required : True, related : 'listAutoScalePolicies,updateAutoScalePolicy'}, {name : 'name', description : 'The name of the autoscale Instance Group', type : 'string', length : 255, required : False, since : '4.18.0'}, {name : 'maxmembers', description : 'The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.', type : 'integer', length : 255, required : True}, {name : 'lbruleid', description : 'The ID of the load balancer rule', type : 'uuid', length : 255, required : True, related : 'createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules'}, {name : 'fordisplay', description : 'An optional field, whether to the display the group to the end user or not', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'scaledownpolicyids', description : 'List of scaledown autoscale policies', type : 'list', length : 255, required : True, related : 'listAutoScalePolicies,updateAutoScalePolicy'}, {name : 'minmembers', description : 'The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.', type : 'integer', length : 255, required : True}, {name : 'interval', description : 'The frequency in which the performance counters to be collected', type : 'integer', length : 255, required : False}], response : [{name : 'privateport', description : 'The private port', type : 'string'}, {name : 'maxmembers', description : 'The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.', type : 'int'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'minmembers', description : 'The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.', type : 'int'}, {name : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {}, {name : 'lbprovider', description : 'The LB provider of the guest Network the LB rule belongs to', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}, {name : 'publicport', description : 'The public port', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'project', description : 'The project name of the Instance group', type : 'string'}, {name : 'state', description : 'The current state of the AutoScale Instance Group', type : 'string'}, {name : 'projectid', description : 'The project id of the Instance group', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the guest Network the LB rule belongs to', type : 'string'}, {name : 'publicip', description : 'The public IP address', type : 'string'}, {name : 'created', description : 'The date when this Instance group was created', type : 'date'}, {name : 'domainpath', description : 'path of the domain to which the vm group belongs', type : 'string'}, {name : 'publicipid', description : 'The public IP address ID', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance group', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {name : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {name : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}], httprequesttype : 'POST'}, {name : 'createNetworkPermissions', description : 'Updates network permissions.', since : '4.17.0', isasync : False, params : [{name : 'projectids', description : 'A comma delimited list of projects within owner\'s domain. If specified, "op" parameter has to be passed in.', type : 'list', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'accounts', description : 'A comma delimited list of accounts within owner\'s domain. If specified, "op" parameter has to be passed in.', type : 'list', length : 255, required : False}, {name : 'networkid', description : 'The network ID', type : 'uuid', length : 255, required : True, related : 'createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'accountids', description : 'A comma delimited list of account IDs within owner\'s domain. If specified, "op" parameter has to be passed in.', type : 'list', length : 255, required : False, related : 'createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}], httprequesttype : 'POST'}, {name : 'deleteResourceIcon', description : 'Deletes the resource icon from the specified resource(s)', since : '4.16.0.0', isasync : False, params : [{name : 'resourceids', description : 'List of resources to upload the icon/image for', type : 'list', length : 255, required : True}, {name : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : True}], response : [{}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'checkVolume', description : 'Check the volume for any errors or leaks and also repairs when repair parameter is passed, this is currently supported for KVM only', since : '4.19.1', isasync : True, related : 'attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume', params : [{name : 'id', description : 'The ID of the volume', type : 'uuid', length : 255, required : True, related : 'attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}, {name : 'repair', description : 'parameter to repair the volume, leaks or all are the possible values', type : 'string', length : 255, required : False}], response : [{name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'deviceid', description : 'The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.', type : 'long'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {}, {name : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {name : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'vmstate', description : 'State of the Instance', type : 'string'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'deletePrivateGateway', description : 'Deletes a Private gateway', isasync : True, params : [{name : 'id', description : 'The ID of the private gateway', type : 'uuid', length : 255, required : True, related : 'createPrivateGateway,createPrivateGateway,listPrivateGateways'}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {}], httprequesttype : 'POST'}, {name : 'disableAutoScaleVmGroup', description : 'Disables an AutoScale Instance Group', isasync : True, related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup', params : [{name : 'id', description : 'The ID of the autoscale group', type : 'uuid', length : 255, required : True, related : 'disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup'}], response : [{name : 'publicip', description : 'The public IP address', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {name : 'privateport', description : 'The private port', type : 'string'}, {name : 'lbprovider', description : 'The LB provider of the guest Network the LB rule belongs to', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the guest Network the LB rule belongs to', type : 'string'}, {name : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'projectid', description : 'The project id of the Instance group', type : 'string'}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'minmembers', description : 'The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.', type : 'int'}, {name : 'publicipid', description : 'The public IP address ID', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance group', type : 'string'}, {name : 'publicport', description : 'The public port', type : 'string'}, {name : 'created', description : 'The date when this Instance group was created', type : 'date'}, {name : 'maxmembers', description : 'The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.', type : 'int'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'state', description : 'The current state of the AutoScale Instance Group', type : 'string'}, {name : 'project', description : 'The project name of the Instance group', type : 'string'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainpath', description : 'path of the domain to which the vm group belongs', type : 'string'}, {name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {}], httprequesttype : 'POST'}, {name : 'listSystemVms', description : 'List System VMs.', isasync : False, related : 'migrateSystemVm,startSystemVm,changeServiceForSystemVm', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'The Zone ID of the system VM', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'systemvmtype', description : 'The system VM type. Possible types are "consoleproxy" and "secondarystoragevm".', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'name', description : 'The name of the system VM', type : 'string', length : 255, required : False}, {name : 'state', description : 'The state of the system VM', type : 'string', length : 255, required : False}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string', length : 255, required : False, since : '4.20.1'}, {name : 'storageid', description : "The storage ID where Instance's volumes belong to", type : 'uuid', length : 255, required : False, since : '3.0.1', related : 'cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}, {name : 'podid', description : 'The Pod ID of the system VM', type : 'uuid', length : 255, required : False, related : 'createPod,listPods,updatePod,createManagementNetworkIpRange'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the system VM', type : 'uuid', length : 255, required : False, related : 'listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm'}, {name : 'hostid', description : 'The host ID of the system VM', type : 'uuid', length : 255, required : False, related : 'addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost'}], response : [{name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}], httprequesttype : 'GET'}, {name : 'createVMSchedule', description : 'Create Instance Schedule', since : '4.19.0', isasync : False, related : 'updateVMSchedule', params : [{name : 'enabled', description : 'Enable Instance schedule. Defaults to true', type : 'boolean', length : 255, required : False}, {name : 'virtualmachineid', description : 'ID of the Instance for which schedule is to be defined', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'schedule', description : "Schedule for action on Instance in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", type : 'string', length : 255, required : True}, {name : 'startdate', description : 'Start date from which the schedule becomes active. Defaults to current date plus 1 minute.(Format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'enddate', description : 'End date after which the schedule becomes inactive(Format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'action', description : 'Action to take on the Instance (start/stop/reboot/force_stop/force_reboot).', type : 'string', length : 255, required : True}, {name : 'description', description : 'Description of the schedule', type : 'string', length : 255, required : False}, {name : 'timezone', description : 'Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.', type : 'string', length : 255, required : True}], response : [{name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'schedule', description : 'Cron formatted Instance schedule', type : 'string'}, {name : 'description', description : 'Description of Instance schedule', type : 'string'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {}, {name : 'action', description : 'Action', type : 'action'}, {name : 'virtualmachineid', description : 'ID of Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'The ID of Instance schedule', type : 'string'}, {}, {name : 'enabled', description : 'VM schedule is enabled', type : 'boolean'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}], httprequesttype : 'POST'}, {name : 'createResourceSchedule', description : 'Create Resource Schedule', since : '4.23.0', isasync : False, related : 'listResourceSchedule,updateResourceSchedule', params : [{name : 'resourceid', description : 'ID of the resource for which schedule is to be defined', type : 'string', length : 255, required : True}, {name : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : True}, {name : 'startdate', description : 'Start date from which the schedule becomes active. Defaults to current date plus 1 minute. (Format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'action', description : 'Action to take on the resource.', type : 'string', length : 255, required : True}, {name : 'schedule', description : "Schedule for action on resource in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", type : 'string', length : 255, required : True}, {name : 'enabled', description : 'Enable schedule. Defaults to true', type : 'boolean', length : 255, required : False}, {name : 'description', description : 'Description of the schedule', type : 'string', length : 255, required : False}, {name : 'enddate', description : 'End date after which the schedule becomes inactive. (Format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'details', description : 'Map of (key/value pairs) details for the schedule.', type : 'map', length : 255, required : False}, {name : 'timezone', description : 'Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.', type : 'string', length : 255, required : True}], response : [{name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'action', description : 'Action', type : 'action'}, {name : 'id', description : 'The ID of resource schedule', type : 'string'}, {name : 'enabled', description : 'Resource schedule is enabled', type : 'boolean'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {}, {name : 'resourcetype', description : 'Type of the resource', type : 'apicommandresourcetype'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'details', description : 'Schedule details', type : 'map'}, {}, {name : 'description', description : 'Description of resource schedule', type : 'string'}, {name : 'schedule', description : 'Cron formatted resource schedule', type : 'string'}], httprequesttype : 'POST'}, {name : 'createSharedFileSystem', description : 'Create a new Shared File System of specified size and disk offering, attached to the given network', since : '4.20.0', isasync : True, related : 'listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering', params : [{name : 'maxiops', description : 'max iops', type : 'long', length : 255, required : False}, {name : 'serviceofferingid', description : 'the service offering to use for the shared filesystem instance hosting the data. The offering should be HA enabled and the cpu count and memory size should be greater than equal to sharedfsvm.min.cpu.count and sharedfsvm.min.ram.size respectively', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'filesystem', description : 'the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.', type : 'string', length : 255, required : True}, {name : 'projectid', description : 'the project associated with the shared filesystem. Mutually exclusive with account parameter', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'account', description : 'the account associated with the shared filesystem. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'name', description : 'the name of the shared filesystem.', type : 'string', length : 255, required : True}, {name : 'networkid', description : 'network to attach the shared filesystem to', type : 'uuid', length : 255, required : True, related : 'createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'diskofferingid', description : 'the disk offering to use for the underlying storage. This will define the size and other specifications like encryption and qos for the shared filesystem.', type : 'uuid', length : 255, required : True, related : 'createDiskOffering,cloneDiskOffering,listDiskOfferings'}, {name : 'domainid', description : 'the domain ID associated with the shared filesystem. If used with the account parameter returns the shared filesystem associated with the account for the specified domain.If account is NOT provided then the shared filesystem will be assigned to the caller account and domain.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'provider', description : 'the provider to be used for the shared filesystem. The list of providers can be fetched by using the listSharedFileSystemProviders API.', type : 'string', length : 255, required : False}, {name : 'description', description : 'the description for the shared filesystem.', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'the zone id.', type : 'uuid', length : 255, required : True, related : 'createZone,updateZone,listZones,listZones'}, {name : 'size', description : 'the size of the shared filesystem in GiB', type : 'long', length : 255, required : False}, {name : 'miniops', description : 'min iops', type : 'long', length : 255, required : False}], response : [{name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}]}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}]}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {}, {}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteProjectRole', description : 'Delete Project roles in CloudStack', since : '4.15.0', isasync : False, params : [{name : 'id', description : 'ID of the project role to be deleted', type : 'uuid', length : 255, required : True, related : 'createProjectRole,listProjectRoles,updateProjectRole'}, {name : 'projectid', description : 'ID of the project from where the role is to be deleted', type : 'uuid', length : 255, required : True, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'validateUserTwoFactorAuthenticationCode', description : 'Checks the 2FA code for the user.', since : '4.18.0', isasync : False, params : [{name : 'codefor2fa', description : 'Two factor authentication code', type : 'string', length : 255, required : True}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'updateVmwareDc', description : 'Updates a VMware datacenter details for a zone', since : '4.12.0', isasync : False, related : 'addVmwareDc,listVmwareDcs', params : [{name : 'username', description : 'The username required to connect to resource.', type : 'string', length : 255, required : False}, {name : 'isrecursive', description : 'Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.', type : 'boolean', length : 255, required : False}, {name : 'zoneid', description : 'The zone ID', type : 'uuid', length : 255, required : True, related : 'createZone,updateZone,listZones,listZones'}, {name : 'vcenter', description : 'The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.', type : 'string', length : 255, required : False}, {name : 'password', description : 'The password for specified username.', type : 'string', length : 255, required : False}, {name : 'name', description : 'VMware datacenter name.', type : 'string', length : 255, required : False}], response : [{name : 'vcenter', description : 'The VMware vCenter name/ip', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'The VMware Datacenter ID', type : 'string'}, {}, {name : 'zoneid', description : 'The Zone ID associated with this VMware Datacenter', type : 'long'}, {name : 'name', description : 'The VMware Datacenter name', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'changeOfferingForVolume', description : 'Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering', since : '4.17', isasync : True, related : 'attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume', params : [{name : 'miniops', description : 'New minimum number of IOPS for the custom disk offering', type : 'long', length : 255, required : False}, {name : 'shrinkok', description : 'Verify OK to Shrink', type : 'boolean', length : 255, required : False}, {name : 'automigrate', description : 'Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering', type : 'boolean', length : 255, required : False}, {name : 'maxiops', description : 'New maximum number of IOPS for the custom disk offering', type : 'long', length : 255, required : False}, {name : 'id', description : 'The ID of the volume', type : 'uuid', length : 255, required : True, related : 'attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}, {name : 'diskofferingid', description : 'New disk offering ID', type : 'uuid', length : 255, required : True, related : 'createDiskOffering,cloneDiskOffering,listDiskOfferings'}, {name : 'size', description : 'New volume size in GB for the custom disk offering', type : 'long', length : 255, required : False}], response : [{name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'deviceid', description : 'The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.', type : 'long'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {name : 'vmstate', description : 'State of the Instance', type : 'string'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'status', description : 'The status of the volume', type : 'string'}, {}, {}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}], httprequesttype : 'POST'}, {name : 'createProjectRole', description : 'Creates a Project role', since : '4.15.0', isasync : False, related : 'listProjectRoles,updateProjectRole', params : [{name : 'description', description : 'The description of the Project role', type : 'string', length : 255, required : False}, {name : 'name', description : 'Creates a project role with this unique name', type : 'string', length : 255, required : True}, {name : 'projectid', description : 'ID of project where role is being created', type : 'uuid', length : 255, required : True, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}], response : [{name : 'ispublic', description : 'Indicates whether the role will be visible to all Users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).', type : 'boolean'}, {name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'The name of the role', type : 'string'}, {name : 'description', description : 'The description of the role', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {}, {name : 'id', description : 'The ID of the role', type : 'string'}], httprequesttype : 'POST'}, {name : 'createIpv6FirewallRule', description : 'Creates an IPv6 firewall rule in the given Network (the Network must not belong to VPC)', isasync : True, related : 'updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule', params : [{name : 'networkid', description : 'The Network of the Instance the Ipv6 firewall rule will be created for', type : 'uuid', length : 255, required : True, related : 'createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'icmpcode', description : 'Error code for this ICMP message', type : 'integer', length : 255, required : False}, {name : 'icmptype', description : 'Type of the ICMP message being sent', type : 'integer', length : 255, required : False}, {name : 'cidrlist', description : 'The source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).', type : 'list', length : 255, required : False}, {name : 'startport', description : 'The starting port of Ipv6 firewall rule', type : 'integer', length : 255, required : False}, {name : 'protocol', description : 'The protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number', type : 'string', length : 255, required : True}, {name : 'destcidrlist', description : 'The destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).', type : 'list', length : 255, required : False}, {name : 'traffictype', description : 'The traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified', type : 'string', length : 255, required : False}, {name : 'fordisplay', description : 'An optional field, whether to the display the rule to the end User or not', type : 'boolean', length : 255, required : False}, {name : 'endport', description : 'The ending port of Ipv6 firewall rule', type : 'integer', length : 255, required : False}], response : [{name : 'privateport', description : "The starting port of port forwarding rule's private port range", type : 'string'}, {name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'list', response : [{name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}]}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'state', description : 'The state of the rule', type : 'string'}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {}, {name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {name : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'privateendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {}, {name : 'networkid', description : 'The ID of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', type : 'string'}, {name : 'publicport', description : "The starting port of port forwarding rule's public port range", type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID for the port forwarding rule', type : 'string'}, {name : 'virtualmachinedisplayname', description : 'The Instance display name for the port forwarding rule', type : 'string'}, {name : 'id', description : 'The ID of the port forwarding rule', type : 'string'}, {name : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}], httprequesttype : 'POST'}, {name : 'listBackups', description : 'Lists Instance backups', since : '4.14.0', isasync : False, related : 'updateBackupSchedule', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'name', description : 'list backups by name', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'uuid', length : 255, required : False, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'id', description : 'ID of the backup', type : 'uuid', length : 255, required : False, related : 'updateBackupSchedule,listBackups'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'zoneid', description : 'List backups by zone id', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'listvmdetails', description : 'list backups with VM details', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'backupofferingid', description : 'list backups by backup offering', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listBackupProviderOfferings,importBackupOffering,cloneBackupOffering,listBackupOfferings,updateBackupOffering,createBackupOffering'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'status', description : 'list backups by status', type : 'string', length : 255, required : False, since : '4.23.0'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}], response : [{name : 'uncompressedsize', description : 'Backup uncompressed size in bytes. Only defined if backup is compressed.', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {name : 'id', description : 'ID of the Instance backup', type : 'string'}, {name : 'intervaltype', description : 'Interval type of the backup', type : 'string'}, {name : 'domainid', description : 'Domain ID', type : 'string'}, {name : 'tocheckpointid', description : 'Next checkpoint ID for incremental backups', type : 'string'}, {name : 'account', description : 'Account name', type : 'string'}, {name : 'status', description : 'Backup status', type : 'status'}, {name : 'vmdetails', description : 'Lists the vm specific details for the backup', type : 'map'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'backupofferingname', description : 'Backup offering name', type : 'string'}, {name : 'created', description : 'Backup date', type : 'date'}, {name : 'compressionstatus', description : 'Backup compression status.', type : 'compressionstatus'}, {name : 'name', description : 'name of the backup', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'size', description : 'Backup size in bytes', type : 'long'}, {name : 'accountid', description : 'Account id', type : 'string'}, {name : 'validationstatus', description : 'Backup validation status.', type : 'validationstatus'}, {name : 'volumes', description : 'Backed up volumes', type : 'string'}, {name : 'backupofferingid', description : 'Backup offering id', type : 'string'}, {}, {name : 'fromcheckpointid', description : 'Previous active checkpoint ID for incremental backups', type : 'string'}, {name : 'domain', description : 'Domain name', type : 'string'}, {name : 'vmbackupofferingremoved', description : 'The backup offering corresponding to this backup was removed from the VM', type : 'boolean'}, {name : 'hostid', description : 'Host ID where the backup is running', type : 'string'}, {}, {name : 'type', description : 'Backup type', type : 'string'}, {name : 'zone', description : 'Zone name', type : 'string'}, {name : 'externalid', description : 'External backup id', type : 'string'}, {name : 'virtualsize', description : 'Backup protected (virtual) size in bytes', type : 'long'}, {name : 'description', description : 'description for the backup', type : 'string'}, {name : 'isbackupvmexpunged', description : 'Indicates whether the VM from which the backup was taken is expunged or not', type : 'boolean'}], httprequesttype : 'GET'}, {name : 'updateDnsZone', description : "Updates a DNS Zone's metadata", since : '4.23.0', isasync : False, related : 'createDnsZone,listDnsZones', params : [{name : 'description', description : 'The description of the DNS zone to be updated', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the DNS zone', type : 'uuid', length : 255, required : True, related : 'createDnsZone,listDnsZones,updateDnsZone'}], response : [{name : 'networkid', description : 'ID of the network this zone is associated with', type : 'string'}, {name : 'account', description : 'the account associated with the DNS zone', type : 'string'}, {name : 'networkname', description : 'Name of the network this zone is associated with', type : 'string'}, {name : 'state', description : 'The state of the zone (Active/Inactive)', type : 'state'}, {name : 'dnsserveraccount', description : 'the account name of the DNS server owner', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domain', description : 'the name of the domain associated with the DNS zone', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the DNS server', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'dnsserverid', description : 'ID of the DNS server this zone belongs to', type : 'string'}, {name : 'type', description : 'The type of the zone (Public/Private)', type : 'zonetype'}, {name : 'name', description : 'Name of the DNS zone', type : 'string'}, {name : 'description', description : 'Description for the DNS zone', type : 'string'}, {name : 'id', description : 'ID of the DNS zone', type : 'string'}, {name : 'dnsservername', description : 'the name of the DNS server hosting this zone', type : 'string'}], httprequesttype : 'POST'}, {name : 'setupUserTwoFactorAuthentication', description : 'Setup the 2FA for the user.', since : '4.18.0', isasync : False, related : '', params : [{name : 'userid', description : 'Optional: the id of the User for which 2FA has to be disabled', type : 'uuid', length : 255, required : False, related : 'createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser'}, {name : 'provider', description : 'Two factor authentication code', type : 'string', length : 255, required : False}, {name : 'enable', description : 'Enabled by default, provide false to disable 2FA', type : 'boolean', length : 255, required : False}], response : [{name : 'secretcode', description : 'Secret code that needs to be registered with authenticator', type : 'string'}, {}, {name : 'id', description : 'The user ID', type : 'string'}, {name : 'username', description : 'The user name', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'accountid', description : 'The Account ID of the user', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'deleteWebhookFilter', description : 'Deletes Webhook filter', since : '4.20.0', isasync : False, params : [{name : 'id', description : 'The ID of the Webhook filter', type : 'uuid', length : 255, required : False, related : 'listWebhookFilters'}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,listWebhooks,updateWebhook,listWebhookDeliveries,addWebhookFilter'}], response : [{}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'createDnsZone', description : 'Creates a new DNS Zone on a specific server', since : '4.23.0', isasync : True, related : 'listDnsZones', params : [{name : 'type', description : 'The type of zone (Public, Private). Defaults to Public.', type : 'string', length : 255, required : False}, {name : 'existing', description : 'If true, imports an existing DNS zone from the DNS provider into CloudStack. If false, creates the zone in the DNS provider and registers it in CloudStack. Default is false', type : 'boolean', length : 255, required : False, related : 'createDnsZone,listDnsZones'}, {name : 'name', description : 'The name of the DNS zone (e.g. example.com)', type : 'string', length : 255, required : True}, {name : 'dnsserverid', description : 'The ID of the DNS server to host this zone', type : 'uuid', length : 255, required : True, related : 'addDnsServer,listDnsServers,updateDnsServer'}, {name : 'description', description : 'The description of the DNS zone', type : 'string', length : 255, required : False}], response : [{name : 'state', description : 'The state of the zone (Active/Inactive)', type : 'state'}, {name : 'domainid', description : 'the ID of the domain associated with the DNS server', type : 'string'}, {name : 'dnsserveraccount', description : 'the account name of the DNS server owner', type : 'string'}, {name : 'account', description : 'the account associated with the DNS zone', type : 'string'}, {name : 'description', description : 'Description for the DNS zone', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'type', description : 'The type of the zone (Public/Private)', type : 'zonetype'}, {name : 'networkid', description : 'ID of the network this zone is associated with', type : 'string'}, {name : 'networkname', description : 'Name of the network this zone is associated with', type : 'string'}, {name : 'dnsserverid', description : 'ID of the DNS server this zone belongs to', type : 'string'}, {name : 'dnsservername', description : 'the name of the DNS server hosting this zone', type : 'string'}, {name : 'domain', description : 'the name of the domain associated with the DNS zone', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'id', description : 'ID of the DNS zone', type : 'string'}, {name : 'name', description : 'Name of the DNS zone', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteKubernetesCluster', description : 'Deletes a Kubernetes cluster', isasync : True, params : [{name : 'cleanup', description : 'Destroy attached instances of the ExternalManaged Cluster. Default: false', type : 'boolean', length : 255, required : False, since : '4.19.0'}, {name : 'expunge', description : 'Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false', type : 'boolean', length : 255, required : False, since : '4.19.0'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listWebhooks', description : 'Lists Webhooks', since : '4.20.0', isasync : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries,addWebhookFilter', params : [{name : 'id', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,listWebhooks,updateWebhook,listWebhookDeliveries,addWebhookFilter'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'state', description : 'The state of the Webhook', type : 'string', length : 255, required : False}, {name : 'name', description : 'The name of the Webhook', type : 'string', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'scope', description : 'The scope of the Webhook', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'created', description : 'The date when this Webhook was created', type : 'date'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Webhook exists', type : 'string'}, {}, {name : 'description', description : 'The description of the Webhook', type : 'string'}, {name : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Webhook exists', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', type : 'string'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'account', description : 'The account associated with the Webhook', type : 'string'}, {name : 'project', description : 'the project name of the Kubernetes cluster', type : 'string'}, {name : 'secretkey', description : 'The secret key for the Webhook', type : 'string'}, {}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}, {name : 'projectid', description : 'the project id of the Kubernetes cluster', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'listAffectedVmsForStorageScopeChange', description : 'List user and system VMs that need to be stopped and destroyed respectively for changing the scope of the storage pool from Zone to Cluster.', since : '4.19.1', isasync : False, related : '', params : [{name : 'clusterid', description : 'the Id of the cluster the scope of the storage pool is being changed to', type : 'uuid', length : 255, required : True, related : 'addCluster,updateCluster'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'storageid', description : 'the Id of the storage pool on which change scope operation is being done', type : 'uuid', length : 255, required : True, related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'clusterid', description : 'the cluster ID for the VM', type : 'string'}, {}, {}, {name : 'hostname', description : 'the hostname for the VM', type : 'string'}, {name : 'id', description : 'the ID of the VM', type : 'string'}, {name : 'hostid', description : 'the host ID for the VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'clustername', description : 'the cluster name for the VM', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'the name of the VM', type : 'string'}, {name : 'type', description : 'the type of VM', type : 'string'}], httprequesttype : 'GET'}, {name : 'executeWebhookDelivery', description : 'Executes a Webhook delivery', since : '4.20.0', isasync : False, related : '', params : [{name : 'secretkey', description : 'Secret key of the Webhook delivery', type : 'string', length : 255, required : False}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries,addWebhookFilter'}, {name : 'sslverification', description : 'If set to true then SSL verification will be done for the Webhook delivery otherwise not', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The ID of the Webhook delivery for redelivery', type : 'uuid', length : 255, required : False, related : 'executeWebhookDelivery'}, {name : 'payload', description : 'Payload of the Webhook delivery', type : 'string', length : 255, required : False}, {name : 'payloadurl', description : 'Payload URL of the Webhook delivery', type : 'string', length : 255, required : False}], response : [{name : 'id', description : 'The ID of the Webhook delivery', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'payload', description : 'The payload of the webhook delivery', type : 'string'}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'string'}, {name : 'response', description : 'The response of the webhook delivery', type : 'string'}, {name : 'managementserverid', description : 'The ID of the management server which executed delivery', type : 'string'}, {name : 'success', description : 'Whether Webhook delivery succeeded or not', type : 'boolean'}, {}, {name : 'headers', description : 'The headers of the webhook delivery', type : 'string'}, {name : 'eventtype', description : 'The type of the event', type : 'string'}, {name : 'eventid', description : 'The ID of the event', type : 'string'}, {}, {name : 'managementservername', description : 'The name of the management server which executed delivery', type : 'string'}, {name : 'enddate', description : 'The end time of the Webhook delivery', type : 'date'}, {name : 'webhookname', description : 'The name of the Webhook', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'startdate', description : 'The start time of the Webhook delivery', type : 'date'}], httprequesttype : 'POST'}, {name : 'updateAutoScaleVmGroup', description : 'Updates an existing autoscale Instance group.', isasync : True, related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups', params : [{name : 'customid', description : 'An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only', type : 'string', length : 255, required : False, since : '4.4'}, {name : 'fordisplay', description : 'An optional field, whether to the display the group to the end user or not', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'name', description : 'The name of the autoscale vmgroup', type : 'string', length : 255, required : False, since : '4.18.0'}, {name : 'scaledownpolicyids', description : 'List of scaledown autoscale policies', type : 'list', length : 255, required : False, related : 'listAutoScalePolicies,updateAutoScalePolicy'}, {name : 'minmembers', description : 'The minimum number of members in the vmgroup, the number of Instances in the Instance group will be equal to or more than this number.', type : 'integer', length : 255, required : False}, {name : 'interval', description : 'The frequency in which the performance counters to be collected', type : 'integer', length : 255, required : False}, {name : 'scaleuppolicyids', description : 'List of scaleup autoscale policies', type : 'list', length : 255, required : False, related : 'listAutoScalePolicies,updateAutoScalePolicy'}, {name : 'maxmembers', description : 'The maximum number of members in the vmgroup, The number of Instances in the Instance group will be equal to or less than this number.', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the autoscale group', type : 'uuid', length : 255, required : True, related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup'}], response : [{name : 'publicip', description : 'The public IP address', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the vm group belongs', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the guest Network the LB rule belongs to', type : 'string'}, {name : 'maxmembers', description : 'The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.', type : 'int'}, {name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {name : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {name : 'projectid', description : 'The project id of the Instance group', type : 'string'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {name : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {name : 'domain', description : 'The domain name of the Instance group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'project', description : 'The project name of the Instance group', type : 'string'}, {name : 'privateport', description : 'The private port', type : 'string'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'publicport', description : 'The public port', type : 'string'}, {}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}, {}, {name : 'lbprovider', description : 'The LB provider of the guest Network the LB rule belongs to', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'created', description : 'The date when this Instance group was created', type : 'date'}, {name : 'minmembers', description : 'The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.', type : 'int'}, {name : 'state', description : 'The current state of the AutoScale Instance Group', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'publicipid', description : 'The public IP address ID', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listVirtualMachines', description : 'List the Instances owned by the account.', isasync : False, related : 'assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm', params : [{name : 'groupid', description : 'The group ID', type : 'uuid', length : 255, required : False, related : 'createInstanceGroup,updateInstanceGroup'}, {name : 'extensionid', description : 'The ID of the Orchestrator extension for the VM', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'createExtension,listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension'}, {name : 'userdataid', description : 'the instances by userdata', type : 'uuid', length : 255, required : False, since : '4.20.1', related : 'listCniConfiguration'}, {name : 'displayvm', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'userid', description : 'The user ID that created the Instance and is under the Account that owns the Instance', type : 'uuid', length : 255, required : False, related : 'createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser'}, {name : 'keypair', description : 'List Instances by SSH keypair name', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'haenable', description : 'List by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabled', type : 'boolean', length : 255, required : False, since : '4.15'}, {name : 'showicon', description : 'Flag to display the resource icon for Instances', type : 'boolean', length : 255, required : False, since : '4.16.0.0'}, {name : 'vpcid', description : 'List Instances by VPC', type : 'uuid', length : 255, required : False, related : 'listVPCs,createVPC,listVPCs,updateVPC,migrateVPC'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string', length : 255, required : False, since : '4.20.1'}, {name : 'id', description : 'The ID of the Instance', type : 'uuid', length : 255, required : False, related : 'assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'isoid', description : 'List Instances by ISO', type : 'uuid', length : 255, required : False}, {name : 'autoscalevmgroupid', description : 'The ID of AutoScaling Instance Group', type : 'uuid', length : 255, required : False, since : '4.18.0', related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups'}, {name : 'gpuenabled', description : 'Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'ids', description : 'The IDs of the Instances, mutually exclusive with id', type : 'list', length : 255, required : False, since : '4.4', related : 'assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'podid', description : 'The pod ID', type : 'uuid', length : 255, required : False, related : 'createPod,listPods,updatePod,createManagementNetworkIpRange'}, {name : 'isvnf', description : 'flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.', type : 'boolean', length : 255, required : False, since : '4.19.0'}, {name : 'backupofferingid', description : 'List by the backup offering', type : 'uuid', length : 255, required : False, since : '4.17', related : 'listBackupProviderOfferings,importBackupOffering,cloneBackupOffering,listBackupOfferings,updateBackupOffering,createBackupOffering'}, {name : 'accumulate', description : 'Accumulates the Instance metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.', type : 'boolean', length : 255, required : False, since : '4.17.0'}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", type : 'boolean', length : 255, required : False}, {name : 'hostid', description : 'The host ID', type : 'uuid', length : 255, required : False, related : 'addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'hypervisor', description : 'The target hypervisor for the Template', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'storageid', description : "The storage ID where Instance's volumes belong to", type : 'uuid', length : 255, required : False, related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}, {name : 'leased', description : 'Whether to return only leased instances', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'state', description : 'State of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'clusterid', description : 'The cluster ID', type : 'uuid', length : 255, required : False, since : '4.16.0', related : 'addCluster,updateCluster'}, {name : 'securitygroupid', description : 'The security group ID', type : 'uuid', length : 255, required : False, since : '4.15', related : 'createSecurityGroup,updateSecurityGroup'}, {name : 'affinitygroupid', description : 'List Instances by affinity group', type : 'uuid', length : 255, required : False, related : 'createAffinityGroup,listAffinityGroups'}, {name : 'templateid', description : 'List Instances by Template', type : 'uuid', length : 255, required : False, related : 'prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'details', description : 'Comma separated list of Instance details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.', type : 'list', length : 255, required : False}, {name : 'serviceofferingid', description : 'List by the service offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'forvirtualnetwork', description : 'List by Network type; true if need to list Instances using Virtual Network, false otherwise', type : 'boolean', length : 255, required : False}, {name : 'userdata', description : "Whether to return the Instances' User data or not. By default, User data will not be returned.", type : 'boolean', length : 255, required : False, since : '4.18.0.0'}, {name : 'name', description : 'Name of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)', type : 'string', length : 255, required : False}, {name : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}]}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}]}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}]}]}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}]}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}]}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}]}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}], httprequesttype : 'GET'}, {name : 'upgradeKubernetesCluster', description : 'Upgrades a running CloudManaged Kubernetes cluster', isasync : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for upgrade', type : 'uuid', length : 255, required : True, related : 'addKubernetesSupportedVersion,getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion'}], response : [{name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'revertToVMSnapshot', description : 'Revert Instance from a vmsnapshot.', since : '4.2.0', isasync : True, related : 'assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm', params : [{name : 'vmsnapshotid', description : 'The ID of the Instance Snapshot', type : 'uuid', length : 255, required : True, related : 'listVMSnapshot,createVMSnapshot'}], response : [{name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}]}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}, {name : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}]}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}]}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}]}, {name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}]}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}]}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}]}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}]}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}]}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}], httprequesttype : 'POST'}, {name : 'recoverSharedFileSystem', description : 'Recover a Shared FileSystem by id', since : '4.20.0', isasync : False, params : [{name : 'id', description : 'the ID of the shared filesystem to recover', type : 'uuid', length : 255, required : False, related : 'listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}], httprequesttype : 'POST'}, {name : 'addWebhookFilter', description : 'Adds a Webhook filter', since : '4.23.0', isasync : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries', params : [{name : 'mode', description : 'Mode for the Webhook filter - Include or Exclude', type : 'string', length : 255, required : False}, {name : 'value', description : 'Value for the Webhook which that will be matched', type : 'string', length : 255, required : True}, {name : 'matchtype', description : 'Match type for the Webhook filter - Exact, Prefix, Suffix or Contains', type : 'string', length : 255, required : False}, {name : 'webhookid', description : 'ID for the Webhook', type : 'uuid', length : 255, required : True, related : 'createWebhook,updateWebhook,listWebhookDeliveries,addWebhookFilter'}], response : [{name : 'projectid', description : 'the project id of the Kubernetes cluster', type : 'string'}, {name : 'secretkey', description : 'The secret key for the Webhook', type : 'string'}, {}, {}, {name : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Webhook exists', type : 'string'}, {name : 'created', description : 'The date when this Webhook was created', type : 'date'}, {name : 'description', description : 'The description of the Webhook', type : 'string'}, {name : 'account', description : 'The account associated with the Webhook', type : 'string'}, {name : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {name : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Webhook exists', type : 'string'}, {name : 'project', description : 'the project name of the Kubernetes cluster', type : 'string'}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listNetworkProtocols', description : 'Lists details of network protocols', since : '4.19.0', isasync : False, related : '', params : [{name : 'option', description : 'The option of network protocols. Supported values are: protocolnumber, icmptype.', type : 'string', length : 255, required : True}], response : [{name : 'index', description : 'the index (ID, Value, Code, Type, Option, etc) of the protocol parameter', type : 'integer'}, {name : 'description', description : 'the description of the protocol parameter', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'the name of the protocol parameter', type : 'string'}, {name : 'details', description : 'the details of the protocol parameter', type : 'map'}], httprequesttype : 'GET'}, {name : 'listGuiThemes', description : 'Lists GUI themes.', since : '4.21.0.0', isasync : False, related : 'createGuiTheme', params : [{name : 'listonlydefaulttheme', description : 'Whether to only list the default theme.', type : 'boolean', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'accountid', description : 'The ID of the account to be filtered.', type : 'uuid', length : 255, required : False, related : 'disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts'}, {name : 'listall', description : 'Whether to list all themes.', type : 'boolean', length : 255, required : False}, {name : 'showpublic', description : 'Whether to list public themes.', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The theme ID.', type : 'uuid', length : 255, required : False, related : 'listGuiThemes,createGuiTheme'}, {name : 'domainid', description : 'The ID of the domain to be filtered.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'showremoved', description : 'Whether to list removed themes.', type : 'boolean', length : 255, required : False}, {name : 'commonname', description : 'The internet Common Name (CN) to be filtered.', type : 'string', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'name', description : 'The name of the theme.', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'recursivedomains', description : 'Whether to consider the subdomains of the informed domain IDs.', type : 'boolean'}, {name : 'jsonconfiguration', description : 'The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.', type : 'string'}, {name : 'name', description : 'Name of the GUI theme.', type : 'string'}, {name : 'id', description : 'ID of the custom GUI theme.', type : 'string'}, {name : 'accountids', description : 'A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.', type : 'string'}, {}, {name : 'loginbasedomain', description : 'The ACS domain to be used as base for the login when accessing the GUI through the common name defined in the theme. If a common name is not defined, this parameter is ignored on the GUI.', type : 'string'}, {name : 'domainids', description : 'A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.', type : 'string'}, {name : 'commonnames', description : 'A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'removed', description : 'When the GUI theme was removed.', type : 'date'}, {name : 'description', description : 'Description of the GUI theme.', type : 'string'}, {name : 'created', description : 'When the GUI theme was created.', type : 'date'}, {name : 'css', description : 'The CSS to be retrieved and imported into the GUI when matching the theme access configurations.', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'ispublic', description : 'Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.', type : 'boolean'}], httprequesttype : 'GET'}, {name : 'deleteCniConfiguration', description : 'Deletes a CNI Configuration', since : '4.21.0', isasync : False, params : [{name : 'id', description : 'The ID of the Userdata', type : 'uuid', length : 255, required : True, related : 'listCniConfiguration'}, {name : 'domainid', description : 'An optional domainId for the userdata. If the account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'account', description : 'An optional account for the userdata. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'An optional project for the userdata', type : 'uuid', length : 255, required : False, related : 'activateProject,createProject,suspendProject,updateProject'}], response : [{}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listVmwareDcs', description : 'Retrieves VMware DC(s) associated with a zone.', isasync : False, related : 'addVmwareDc', params : [{name : 'zoneid', description : 'Id of the CloudStack zone.', type : 'uuid', length : 255, required : True, related : 'createZone,listZones,listZones'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'id', description : 'The VMware Datacenter ID', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'vcenter', description : 'The VMware vCenter name/ip', type : 'string'}, {name : 'zoneid', description : 'The Zone ID associated with this VMware Datacenter', type : 'long'}, {name : 'name', description : 'The VMware Datacenter name', type : 'string'}, {}], httprequesttype : 'GET'}, {name : 'deleteBackupSchedule', description : 'Deletes the backup schedule of a Instance', since : '4.14.0', isasync : False, params : [{name : 'virtualmachineid', description : 'ID of the VM from which all backup schedules will be deleted.', type : 'uuid', length : 255, required : False, related : 'assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'id', description : "ID of the backup schedule to be deleted. It has precedence over the 'virtualmachineid' parameter, i.e., when the 'id' parameter is specified, the 'virtualmachineid' parameter will be ignored.", type : 'uuid', length : 255, required : False, since : '4.20.1', related : 'listBackupSchedule'}], response : [{}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'listResourceSchedule', description : 'List Resource Schedules', since : '4.23.0', isasync : False, related : 'updateResourceSchedule', params : [{name : 'enabled', description : 'Filter by enabled status.', type : 'boolean', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'resourceid', description : 'ID of the resource for which schedules are to be listed.', type : 'string', length : 255, required : True}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'action', description : 'Action to take on the resource.', type : 'string', length : 255, required : False}, {name : 'id', description : 'ID of the schedule', type : 'uuid', length : 255, required : False, related : 'listResourceSchedule,updateResourceSchedule'}, {name : 'resourcetype', description : 'Type of the resource.', type : 'string', length : 255, required : True}, {name : 'ids', description : 'comma separated list of schedule ids', type : 'list', length : 255, required : False, related : 'listResourceSchedule,updateResourceSchedule'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{}, {name : 'resourcetype', description : 'Type of the resource', type : 'apicommandresourcetype'}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'id', description : 'The ID of resource schedule', type : 'string'}, {name : 'description', description : 'Description of resource schedule', type : 'string'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'schedule', description : 'Cron formatted resource schedule', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'enabled', description : 'Resource schedule is enabled', type : 'boolean'}, {name : 'action', description : 'Action', type : 'action'}, {name : 'details', description : 'Schedule details', type : 'map'}], httprequesttype : 'GET'}, {name : 'listVolumesUsageHistory', description : 'Lists volume stats', since : '4.18.0', isasync : False, related : '', params : [{name : 'startdate', description : 'Start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'enddate', description : 'End date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'name', description : 'Name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the volume.', type : 'uuid', length : 255, required : False, related : 'createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'ids', description : 'the IDs of the Volumes, mutually exclusive with id.', type : 'list', length : 255, required : False, related : 'createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}], response : [{}, {name : 'id', description : 'The ID of the volume', type : 'string'}, {name : 'name', description : 'The name of the volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'stats', description : 'The list of VM stats', type : 'list'}], httprequesttype : 'GET'}, {name : 'createProjectRolePermission', description : 'Adds API permissions to a project role', since : '4.15.0', isasync : False, related : 'listProjectRolePermissions', params : [{name : 'permission', description : 'The rule permission, allow or deny. Default: deny.', type : 'string', length : 255, required : True}, {name : 'rule', description : 'The API name or wildcard rule such as list*', type : 'string', length : 255, required : True}, {name : 'description', description : 'The description of the role permission', type : 'string', length : 255, required : False}, {name : 'projectroleid', description : 'ID of the project role', type : 'uuid', length : 255, required : True, related : 'listProjectRoles,updateProjectRole'}, {name : 'projectid', description : 'ID of project where project role permission is to be created', type : 'uuid', length : 255, required : True, related : 'activateProject,createProject,suspendProject'}], response : [{name : 'description', description : 'The description of the role permission', type : 'string'}, {name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'rule', description : 'The api name or wildcard rule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'projectrolename', description : 'The name of the project role to which the role permission belongs', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'permission', description : 'The permission type of the api name or wildcard rule, allow/deny', type : 'string'}, {}, {name : 'id', description : 'The ID of the project role permission', type : 'string'}, {name : 'projectroleid', description : 'The ID of the project role to which the role permission belongs', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteBucket', description : 'Deletes an empty Bucket.', since : '4.19.0', isasync : False, params : [{name : 'id', description : 'The ID of the Bucket', type : 'uuid', length : 255, required : True, related : 'createBucket,listBuckets'}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {}], httprequesttype : 'POST'}, {name : 'createConsoleEndpoint', description : 'Create a console endpoint to connect to a Instance console', since : '4.18.0', isasync : False, related : '', params : [{name : 'virtualmachineid', description : 'ID of the Instance', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'token', description : '(optional) extra security token, valid when the extra validation is enabled', type : 'string', length : 255, required : False}], response : [{name : 'details', description : 'Details in case of an error', type : 'string'}, {}, {name : 'url', description : 'The console url', type : 'string'}, {}, {name : 'websocket', description : 'The console websocket options', type : 'consoleendpointwebsocketresponse'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if the console endpoint is generated properly', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'updateProjectRolePermission', description : 'Updates a project role permission and/or order', since : '4.15.0', isasync : False, params : [{name : 'projectid', description : 'ID of project where project role permission is to be updated', type : 'uuid', length : 255, required : True, related : 'activateProject,createProject,suspendProject'}, {name : 'projectroleid', description : 'ID of the project role', type : 'uuid', length : 255, required : True, related : 'listProjectRoles,updateProjectRole'}, {name : 'projectrolepermissionid', description : 'Project Role permission rule id', type : 'uuid', length : 255, required : False, related : 'listProjectRolePermissions'}, {name : 'ruleorder', description : 'ID of the parent role permission, use 0 to move this rule at the top of the list', type : 'list', length : 255, required : False, related : 'listProjectRolePermissions'}, {name : 'permission', description : 'Rule permission, can be: allow or deny', type : 'string', length : 255, required : False}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'addUserToProject', description : 'Adds User to a project', since : '4.14', isasync : True, params : [{name : 'username', description : 'Name of the User to be added to the project', type : 'string', length : 255, required : True}, {name : 'roletype', description : 'Project role type to be assigned to the User - Admin/Regular', type : 'string', length : 255, required : False}, {name : 'email', description : 'Email ID of User to which invitation to the project is going to be sent', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'ID of the project to add the User to', type : 'uuid', length : 255, required : True, related : 'activateProject,createProject,suspendProject'}, {name : 'projectroleid', description : 'ID of the project role', type : 'uuid', length : 255, required : False, related : 'listProjectRoles,updateProjectRole'}], response : [{}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'resetNetworkPermissions', description : 'Resets Network permissions.', since : '4.17.0', isasync : False, params : [{name : 'networkid', description : 'The Network ID', type : 'uuid', length : 255, required : True, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'listWebhookFilters', description : 'Lists Webhook filters', since : '4.23.0', isasync : False, related : '', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the Webhook delivery', type : 'uuid', length : 255, required : False, related : ''}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'id', description : 'The ID of the Webhook filter', type : 'string'}, {name : 'created', description : 'The type of the Webhook filter', type : 'date'}, {name : 'matchtype', description : 'The type of the Webhook filter', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'mode', description : 'The type of the Webhook filter', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'webhookname', description : 'The name of the Webhook', type : 'string'}, {name : 'value', description : 'The type of the Webhook filter', type : 'string'}, {name : 'type', description : 'The type of the Webhook filter', type : 'string'}, {}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateCondition', description : 'Updates a condition for Instance auto scaling', since : '4.18.0', isasync : True, params : [{name : 'relationaloperator', description : 'Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.', type : 'string', length : 255, required : True}, {name : 'id', description : 'The ID of the condition.', type : 'uuid', length : 255, required : True, related : 'listConditions'}, {name : 'threshold', description : 'Value for which the Counter will be evaluated with the Operator selected.', type : 'long', length : 255, required : True}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], httprequesttype : 'POST'}, {name : 'migrateSystemVm', description : 'Attempts Migration of a System VM to the host specified.', isasync : True, related : 'startSystemVm,changeServiceForSystemVm', params : [{name : 'hostid', description : 'Destination Host ID to migrate Instance to', type : 'uuid', length : 255, required : False, related : 'addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost'}, {name : 'autoselect', description : 'Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default', type : 'boolean', length : 255, required : False, since : '4.16.0'}, {name : 'virtualmachineid', description : 'The ID of the Instance', type : 'uuid', length : 255, required : True, related : 'migrateSystemVm,startSystemVm,changeServiceForSystemVm'}, {name : 'storageid', description : 'Destination storage pool ID to migrate Instance volumes to. Required for migrating the root disk volume', type : 'uuid', length : 255, required : False, since : '4.16.0', related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}], response : [{name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {}, {}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}], httprequesttype : 'POST'}, {name : 'createRoutingFirewallRule', description : 'Creates a routing firewall rule in the given network in ROUTED mode', since : '4.20.0', isasync : True, related : 'updateIpv6FirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule', params : [{name : 'fordisplay', description : 'an optional field, whether to the display the rule to the end user or not', type : 'boolean', length : 255, required : False}, {name : 'cidrlist', description : 'the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).', type : 'list', length : 255, required : False}, {name : 'icmpcode', description : 'error code for this ICMP message', type : 'integer', length : 255, required : False}, {name : 'traffictype', description : 'the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified', type : 'string', length : 255, required : False}, {name : 'networkid', description : 'The network of the VM the firewall rule will be created for', type : 'uuid', length : 255, required : True, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'endport', description : 'the ending port of firewall rule', type : 'integer', length : 255, required : False}, {name : 'startport', description : 'the starting port of firewall rule', type : 'integer', length : 255, required : False}, {name : 'icmptype', description : 'type of the ICMP message being sent', type : 'integer', length : 255, required : False}, {name : 'protocol', description : 'the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number', type : 'string', length : 255, required : True}, {name : 'destcidrlist', description : 'the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).', type : 'list', length : 255, required : False}], response : [{name : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {name : 'state', description : 'The state of the rule', type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID for the port forwarding rule', type : 'string'}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'The ID of the port forwarding rule', type : 'string'}, {name : 'privateendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'networkid', description : 'The ID of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'list', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'publicport', description : "The starting port of port forwarding rule's public port range", type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', type : 'string'}, {name : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {}, {name : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {name : 'virtualmachinedisplayname', description : 'The Instance display name for the port forwarding rule', type : 'string'}, {}, {name : 'privateport', description : "The starting port of port forwarding rule's private port range", type : 'string'}, {name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}], httprequesttype : 'POST'}, {name : 'listNetworkPermissions', description : 'List Network visibility and all Accounts that have permissions to view this Network.', since : '4.17.0', isasync : False, related : '', params : [{name : 'networkid', description : 'Lists Network permission by Network ID', type : 'uuid', length : 255, required : True, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}], response : [{}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'project', description : 'The project the Network is available for', type : 'string'}, {name : 'domainid', description : 'The ID of the domain to which the Network belongs', type : 'string'}, {name : 'accountid', description : 'The ID of Account the Network is available for', type : 'string'}, {name : 'domain', description : 'The name of the domain to which the Network belongs', type : 'string'}, {name : 'projectid', description : 'The ID of project the Network is available for', type : 'string'}, {name : 'account', description : 'The Account the Network is available for', type : 'string'}, {name : 'networkid', description : 'The Network ID', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'removeVirtualMachineFromBackupOffering', description : 'Removes an Instance from any existing backup offering', since : '4.14.0', isasync : True, params : [{name : 'virtualmachineid', description : 'ID of the  Instance', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'forced', description : 'Whether to force remove Instance from the backup offering that may also delete Instance backups.', type : 'boolean', length : 255, required : False}], response : [{}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'updateResourceSchedule', description : 'Update Resource Schedule', since : '4.23.0', isasync : False, related : '', params : [{name : 'enabled', description : 'Enable or disable the schedule.', type : 'boolean', length : 255, required : False}, {name : 'timezone', description : 'Specifies a timezone for this command.', type : 'string', length : 255, required : False}, {name : 'description', description : 'Description of the schedule', type : 'string', length : 255, required : False}, {name : 'schedule', description : 'Schedule for action on resource in cron format.', type : 'string', length : 255, required : False}, {name : 'details', description : 'Map of (key/value pairs) details for the schedule.', type : 'map', length : 255, required : False}, {name : 'id', description : 'ID of the schedule to be updated', type : 'uuid', length : 255, required : True, related : 'updateResourceSchedule'}, {name : 'startdate', description : 'Start date from which the schedule becomes active.', type : 'date', length : 255, required : False}, {name : 'enddate', description : 'End date after which the schedule becomes inactive.', type : 'date', length : 255, required : False}], response : [{}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'details', description : 'Schedule details', type : 'map'}, {name : 'resourcetype', description : 'Type of the resource', type : 'apicommandresourcetype'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'action', description : 'Action', type : 'action'}, {name : 'schedule', description : 'Cron formatted resource schedule', type : 'string'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {name : 'id', description : 'The ID of resource schedule', type : 'string'}, {name : 'description', description : 'Description of resource schedule', type : 'string'}, {name : 'enabled', description : 'Resource schedule is enabled', type : 'boolean'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'listWebhookDeliveries', description : 'Lists Webhook deliveries', since : '4.20.0', isasync : False, related : 'createWebhook,updateWebhook', params : [{name : 'eventtype', description : 'The event type of the Webhook delivery', type : 'string', length : 255, required : False}, {name : 'enddate', description : 'The end date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having end date equal to or before the specified date will be listed.', type : 'date', length : 255, required : False}, {name : 'managementserverid', description : 'The ID of the management server', type : 'uuid', length : 255, required : False, related : 'listManagementServers'}, {name : 'startdate', description : 'The start date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having start date equal to or after the specified date will be listed.', type : 'date', length : 255, required : False}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the Webhook delivery', type : 'uuid', length : 255, required : False, related : ''}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'description', description : 'The description of the Webhook', type : 'string'}, {name : 'projectid', description : 'the project id of the Kubernetes cluster', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {name : 'secretkey', description : 'The secret key for the Webhook', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Webhook exists', type : 'string'}, {name : 'created', description : 'The date when this Webhook was created', type : 'date'}, {name : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {}, {name : 'project', description : 'the project name of the Kubernetes cluster', type : 'string'}, {name : 'account', description : 'The account associated with the Webhook', type : 'string'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {name : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Webhook exists', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', type : 'string'}], httprequesttype : 'GET'}, {name : 'restartSharedFileSystem', description : 'Restart a Shared FileSystem', since : '4.20.0', isasync : True, params : [{name : 'cleanup', description : 'is cleanup required', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'addVmwareDc', description : 'Adds a VMware datacenter to specified zone', isasync : False, related : '', params : [{name : 'password', description : 'The password for specified username.', type : 'string', length : 255, required : False}, {name : 'vcenter', description : 'The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.', type : 'string', length : 255, required : True}, {name : 'zoneid', description : 'The Zone ID.', type : 'uuid', length : 255, required : True, related : 'createZone,listZones'}, {name : 'name', description : 'Name of VMware datacenter to be added to specified zone.', type : 'string', length : 255, required : True}, {name : 'username', description : 'The Username required to connect to resource.', type : 'string', length : 255, required : False}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'vcenter', description : 'The VMware vCenter name/ip', type : 'string'}, {name : 'name', description : 'The VMware Datacenter name', type : 'string'}, {}, {name : 'id', description : 'The VMware Datacenter ID', type : 'string'}, {name : 'zoneid', description : 'The Zone ID associated with this VMware Datacenter', type : 'long'}], httprequesttype : 'POST'}, {name : 'updateIpv6FirewallRule', description : 'Updates Ipv6 firewall rule with specified ID', isasync : True, related : 'listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule', params : [{name : 'cidrlist', description : 'The cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).', type : 'list', length : 255, required : False}, {name : 'customid', description : 'An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only', type : 'string', length : 255, required : False, since : '4.4'}, {name : 'endport', description : 'The ending port of Ipv6 firewall rule', type : 'integer', length : 255, required : False}, {name : 'fordisplay', description : 'An optional field, whether to the display the Ipv6 firewall rule to the end User or not', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'icmptype', description : 'Type of the ICMP message being sent', type : 'integer', length : 255, required : False}, {name : 'traffictype', description : 'The traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified', type : 'string', length : 255, required : False}, {name : 'startport', description : 'The starting port of Ipv6 firewall rule', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the IPv6 firewall rule', type : 'uuid', length : 255, required : True, related : 'updateIpv6FirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule'}, {name : 'icmpcode', description : 'Error code for this ICMP message', type : 'integer', length : 255, required : False}, {name : 'protocol', description : 'The protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number', type : 'string', length : 255, required : False}], response : [{name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {name : 'privateendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'networkid', description : 'The ID of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'publicport', description : "The starting port of port forwarding rule's public port range", type : 'string'}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID for the port forwarding rule', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'virtualmachinedisplayname', description : 'The Instance display name for the port forwarding rule', type : 'string'}, {name : 'state', description : 'The state of the rule', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'list', response : [{name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {name : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}, {name : 'id', description : 'The ID of the port forwarding rule', type : 'string'}, {name : 'privateport', description : "The starting port of port forwarding rule's private port range", type : 'string'}, {name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {}, {}], httprequesttype : 'POST'}, {name : 'getVMPassword', description : 'Returns an encrypted password for the Instance', isasync : False, related : '', params : [{name : 'id', description : 'The ID of the Instance', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}], response : [{name : 'encryptedpassword', description : 'The base64 encoded encrypted password of the Instance', type : 'string'}, {}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'listAutoScaleVmGroups', description : 'Lists autoscale Instance groups.', isasync : False, related : 'enableAutoScaleVmGroup', params : [{name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'The name of the autoscale vmgroup', type : 'string', length : 255, required : False, since : '4.18.0'}, {name : 'lbruleid', description : 'The ID of the loadbalancer', type : 'uuid', length : 255, required : False, related : 'listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'policyid', description : 'The ID of the policy', type : 'uuid', length : 255, required : False, related : 'listAutoScalePolicies'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the autoscale Instance group', type : 'uuid', length : 255, required : False, related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'activateProject,createProject'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'fordisplay', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'zoneid', description : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'vmprofileid', description : 'The ID of the profile', type : 'uuid', length : 255, required : False, related : 'createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile'}], response : [{name : 'publicipid', description : 'The public IP address ID', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {name : 'minmembers', description : 'The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.', type : 'int'}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'associatednetworkname', description : 'The name of the guest Network the LB rule belongs to', type : 'string'}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'maxmembers', description : 'The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.', type : 'int'}, {name : 'privateport', description : 'The private port', type : 'string'}, {name : 'publicip', description : 'The public IP address', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the vm group belongs', type : 'string'}, {name : 'project', description : 'The project name of the Instance group', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance group', type : 'string'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'created', description : 'The date when this Instance group was created', type : 'date'}, {name : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {name : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'lbprovider', description : 'The LB provider of the guest Network the LB rule belongs to', type : 'string'}, {name : 'projectid', description : 'The project id of the Instance group', type : 'string'}, {name : 'state', description : 'The current state of the AutoScale Instance Group', type : 'string'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'publicport', description : 'The public port', type : 'string'}], httprequesttype : 'GET'}, {name : 'registerUserData', description : 'Register a new User Data.', since : '4.18', isasync : False, params : [{name : 'projectid', description : 'an optional project for the user data', type : 'uuid', length : 255, required : False, related : 'activateProject,createProject'}, {name : 'domainid', description : 'an optional domainId for the user data. If the account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'account', description : 'an optional account for the user data. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'userdata', description : 'Base64 encoded User Data content. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 32KB of data after base64 encoding, which can be increased upto 1MB using the vm.userdata.max.length setting', type : 'string', length : 1048576, required : True}, {name : 'params', description : 'comma separated list of variables declared in user data content', type : 'string', length : 255, required : False}, {name : 'name', description : 'Name of the user data', type : 'string', length : 255, required : True}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'listAccounts', description : 'Lists Accounts and provides detailed Account information for listed Accounts', isasync : False, related : 'disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts', params : [{name : 'tag', description : 'Tag for resource type to return usage', type : 'string', length : 255, required : False, since : '4.20.0'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'iscleanuprequired', description : 'List accounts by cleanuprequired attribute (values are true or false)', type : 'boolean', length : 255, required : False}, {name : 'state', description : 'List accounts by state. Valid states are enabled, disabled, and locked.', type : 'string', length : 255, required : False}, {name : 'accounttype', description : 'List Accounts by Account type. Valid Account types are 1 (admin), 2 (domain-admin), and 0 (user).', type : 'integer', length : 255, required : False}, {name : 'showicon', description : 'Flag to display the resource icon for accounts', type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'List Account by Account ID', type : 'uuid', length : 255, required : False, related : 'disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts'}, {name : 'details', description : 'Comma separated list of account details requested, value can be a list of [ all, resource, min]', type : 'list', length : 255, required : False}, {name : 'apikeyaccess', description : 'List accounts by the Api key access value', type : 'string', length : 255, required : False, since : '4.20.1.0'}, {name : 'name', description : 'List account by account name', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}], response : [{name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'name', description : 'The name of the Account', type : 'string'}, {name : 'backupavailable', description : 'the total number of backups available to this account', type : 'string'}, {name : 'cpulimit', description : 'The total number of CPU cores the account can own', type : 'string'}, {name : 'templateavailable', description : 'The total number of Templates available to be created by this Account', type : 'string'}, {name : 'vmlimit', description : 'The total number of Instances that can be deployed by this Account', type : 'string'}, {name : 'id', description : 'The ID of the Account', type : 'string'}, {name : 'vmrunning', description : 'The total number of Instances running for this Account', type : 'integer'}, {name : 'roletype', description : 'The type of the role (Admin, ResourceAdmin, DomainAdmin, User)', type : 'string'}, {name : 'vpcavailable', description : 'The total number of VPCs available to be created for this account', type : 'string'}, {name : 'bucketavailable', description : 'the total number of buckets available to this account', type : 'string'}, {name : 'primarystoragelimit', description : 'The total primary storage space (in GiB) the account can own', type : 'string'}, {name : 'networktotal', description : 'The total number of Networks owned by Account', type : 'long'}, {name : 'projecttotal', description : 'The total number of projects being administrated by this Account', type : 'long'}, {name : 'snapshotavailable', description : 'The total number of Snapshots available for this Account', type : 'string'}, {name : 'user', description : 'The list of users associated with account', type : 'list', response : [{name : 'is2famandated', description : 'True if user has two factor authentication is mandated', type : 'boolean'}, {name : 'apikey', description : 'The API key of the user', type : 'string'}, {name : 'isdefault', description : 'True if user is default, false otherwise', type : 'boolean'}, {name : 'apikeyaccess', description : 'Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)', type : 'apikeyaccess'}, {name : 'accounttype', description : 'The Account type of the user', type : 'integer'}, {name : 'lastname', description : 'The user lastname', type : 'string'}, {name : 'roleid', description : 'The ID of the role', type : 'string'}, {name : 'timezone', description : 'The timezone user was created in', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'accountid', description : 'The Account ID of the user', type : 'string'}, {name : 'roletype', description : 'The type of the role', type : 'string'}, {name : 'is2faenabled', description : 'True if user has two factor authentication enabled', type : 'boolean'}, {name : 'secretkey', description : 'The secret key of the user', type : 'string'}, {name : 'username', description : 'The user name', type : 'string'}, {name : 'state', description : 'The user state', type : 'string'}, {name : 'usersource', description : 'The source type of the user in lowercase, such as native, ldap, saml2', type : 'string'}, {name : 'iscallerchilddomain', description : "The boolean value representing if the updating target is in caller's child domain", type : 'boolean'}, {name : 'email', description : 'The user email address', type : 'string'}, {name : 'id', description : 'The user ID', type : 'string'}, {name : 'domainid', description : 'The domain ID of the user', type : 'string'}, {name : 'firstname', description : 'The user firstname', type : 'string'}, {name : 'created', description : 'The date and time the user Account was created', type : 'date'}, {name : 'domain', description : 'The domain name of the user', type : 'string'}, {name : 'account', description : 'The Account name of the user', type : 'string'}, {name : 'rolename', description : 'The name of the role', type : 'string'}]}, {name : 'templatelimit', description : 'The total number of Templates which can be created by this Account', type : 'string'}, {name : 'bucketlimit', description : 'the total number of buckets which can be stored by this account', type : 'string'}, {name : 'networklimit', description : 'The total number of Networks the Account can own', type : 'string'}, {name : 'vmstopped', description : 'The total number of Instances stopped for this Account', type : 'integer'}, {name : 'iptotal', description : 'The total number of public IP addresses allocated for this Account', type : 'long'}, {name : 'rolename', description : 'The name of the role', type : 'string'}, {name : 'created', description : 'The date when this account was created', type : 'date'}, {name : 'apikeyaccess', description : 'whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)', type : 'apikeyaccess'}, {name : 'objectstorageavailable', description : 'the total object storage space (in GiB) available to the account', type : 'string'}, {name : 'vmtotal', description : 'The total number of Instances deployed by this Account', type : 'long'}, {name : 'secondarystoragelimit', description : 'The total secondary storage space (in GiB) the account can own', type : 'string'}, {name : 'isdefault', description : 'True if account is default, false otherwise', type : 'boolean'}, {name : 'backuptotal', description : 'the total number of backups stored by this account', type : 'long'}, {name : 'ipavailable', description : 'The total number of public IP addresses available for this Account to acquire', type : 'string'}, {name : 'snapshottotal', description : 'The total number of Snapshots stored by this Account', type : 'long'}, {name : 'gpuavailable', description : 'the total number of gpus available to be created for this account', type : 'string'}, {name : 'domainid', description : 'ID of the Domain the Account belongs to', type : 'string'}, {name : 'accountdetails', description : 'Details for the account', type : 'map'}, {name : 'iplimit', description : 'The total number of public IP addresses this Account can acquire', type : 'string'}, {name : 'vpctotal', description : 'The total number of VPCs owned by account', type : 'long'}, {name : 'snapshotlimit', description : 'The total number of Snapshots which can be stored by this Account', type : 'string'}, {name : 'vpclimit', description : 'The total number of VPCs the Account can own', type : 'string'}, {name : 'defaultzoneid', description : 'The default zone of the Account', type : 'string'}, {name : 'taggedresources', description : 'The tagged resource limit and count for the account', type : 'list'}, {name : 'cputotal', description : 'The total number of CPU cores owned by account', type : 'long'}, {name : 'volumeavailable', description : 'The total volume available for this Account', type : 'string'}, {name : 'memoryavailable', description : 'The total memory (in MB) available to be created for this account', type : 'string'}, {name : 'networkdomain', description : 'The Network domain', type : 'string'}, {}, {name : 'domainpath', description : 'Path of the Domain the Account belongs to', type : 'string'}, {name : 'volumelimit', description : 'The total volume which can be used by this Account', type : 'string'}, {name : 'secondarystoragetotal', description : 'The total secondary storage space (in GiB) owned by account', type : 'float'}, {name : 'buckettotal', description : 'the total number of buckets stored by this account', type : 'long'}, {name : 'backuplimit', description : 'the total number of backups which can be stored by this account', type : 'string'}, {name : 'roleid', description : 'The ID of the role', type : 'string'}, {name : 'networkavailable', description : 'The total number of Networks available to be created for this Account', type : 'string'}, {name : 'projectlimit', description : 'The total number of projects the Account can own', type : 'string'}, {name : 'volumetotal', description : 'The total volume being used by this Account', type : 'long'}, {name : 'secondarystorageavailable', description : 'The total secondary storage space (in GiB) available to be used for this account', type : 'string'}, {name : 'backupstoragetotal', description : 'the total backup storage space (in GiB) owned by the account', type : 'long'}, {name : 'gpulimit', description : 'the total number of gpus the account can own', type : 'string'}, {name : 'backupstoragelimit', description : 'the total backup storage space (in GiB) the account can own', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'templatetotal', description : 'The total number of Templates which have been created by this Account', type : 'long'}, {name : 'objectstoragelimit', description : 'the total object storage space (in GiB) the account can own', type : 'string'}, {name : 'state', description : 'The state of the account', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'cpuavailable', description : 'The total number of CPU cores available to be created for this account', type : 'string'}, {name : 'accounttype', description : 'Account type (admin, domain-admin, user)', type : 'integer'}, {name : 'projectavailable', description : 'The total number of projects available for administration by this Account', type : 'string'}, {name : 'vmavailable', description : 'The total number of Instances available for this Account to acquire', type : 'string'}, {name : 'primarystorageavailable', description : 'The total primary storage space (in GiB) available to be used for this account', type : 'string'}, {name : 'gputotal', description : 'the total number of gpus owned by account', type : 'long'}, {name : 'iscleanuprequired', description : 'True if the account requires cleanup', type : 'boolean'}, {name : 'backupstorageavailable', description : 'the total backup storage space (in GiB) available to the account', type : 'string'}, {name : 'objectstoragetotal', description : 'the total object storage space (in GiB) owned by the account', type : 'long'}, {}, {name : 'domain', description : 'Name of the Domain the Account belongs to', type : 'string'}, {name : 'memorytotal', description : 'The total memory (in MB) owned by account', type : 'long'}, {name : 'primarystoragetotal', description : 'The total primary storage space (in GiB) owned by account', type : 'long'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'memorylimit', description : 'The total memory (in MB) the account can own', type : 'string'}, {name : 'groups', description : 'The list of ACL groups that account belongs to', type : 'list'}], httprequesttype : 'GET'}, {name : 'deleteDnsZone', description : 'Removes a DNS Zone from CloudStack and the external provider', since : '4.23.0', isasync : True, params : [{name : 'unmanage', description : 'If true, removes the DNS zone only from CloudStack; if false, removes it from both CloudStack and the DNS provider. Default: false', type : 'boolean', length : 255, required : False, related : 'listDnsZones'}, {name : 'id', description : 'The ID of the DNS zone', type : 'uuid', length : 255, required : True, related : 'listDnsZones'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'createAutoScaleVmProfile', description : 'Creates a profile that contains information about the Instance which will be provisioned automatically by autoscale feature.', isasync : True, related : 'listAutoScaleVmProfiles,updateAutoScaleVmProfile', params : [{name : 'domainid', description : 'Domain ID of the Account owning an autoscale Instance profile', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'userdatadetails', description : 'used to specify the parameters values for the variables in userdata.', type : 'map', length : 255, required : False, since : '4.18.1'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is expunged', type : 'integer', length : 255, required : False}, {name : 'zoneid', description : 'Availability zone for the auto deployed Instance', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'account', description : 'Account that will own the autoscale Instance profile', type : 'string', length : 255, required : False}, {name : 'counterparam', description : 'counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161', type : 'map', length : 255, required : False}, {name : 'projectid', description : 'An optional project for the autoscale Instance profile', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'templateid', description : 'The Template of the auto deployed Instance', type : 'uuid', length : 255, required : True, related : 'prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'autoscaleuserid', description : 'The ID of the user used to launch and destroy the Instances', type : 'uuid', length : 255, required : False, related : 'disableUser,getUser,listUsers,lockUser'}, {name : 'serviceofferingid', description : 'The service offering of the auto deployed Instance', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId of the auto deployed  Instance.\nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids\'" and "networkids".', type : 'map', length : 255, required : False}, {name : 'fordisplay', description : 'An optional field, whether to the display the profile to the end user or not', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'userdataid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.18.1', related : 'listCniConfiguration'}, {name : 'userdata', description : 'An optional binary data that can be sent to the Instance upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value', type : 'string', length : 1048576, required : False, since : '4.18.0'}], response : [{}, {name : 'fordisplay', description : 'Is profile for display to the regular User', type : 'boolean'}, {}, {name : 'project', description : 'The project name of the Instance profile', type : 'string'}, {name : 'userdata', description : 'Base64 encoded Instance user data', type : 'string'}, {name : 'id', description : 'The autoscale Instance profile ID', type : 'string'}, {name : 'zoneid', description : 'The availability zone to be used while deploying an Instance', type : 'string'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer'}, {name : 'userdatadetails', description : 'list of variables and values for the variables declared in userdata', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'templateid', description : 'The Template to be used while deploying an Instance', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the vm profile belongs', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance profile', type : 'string'}, {name : 'userdatapolicy', description : 'the userdata override policy with the userdata provided while deploying VM', type : 'string'}, {name : 'projectid', description : 'The project id Instance profile', type : 'string'}, {name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance', type : 'map'}, {name : 'userdataname', description : 'the name of userdata used for the VM', type : 'string'}, {name : 'userdataid', description : 'the id of userdata used for the VM', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance profile', type : 'string'}, {}, {name : 'autoscaleuserid', description : 'The ID of the User used to launch and destroy the Instances', type : 'string'}, {name : 'serviceofferingid', description : 'The service offering to be used while deploying an Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], httprequesttype : 'POST'}, {name : 'deleteVnfTemplate', description : 'Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected.', since : '4.19.0', isasync : True, params : [{name : 'forced', description : 'Force delete a Template.', type : 'boolean', length : 255, required : False, since : '4.9+'}, {name : 'id', description : 'The ID of the Template', type : 'uuid', length : 255, required : True, related : 'prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'issystem', description : "Necessary if the template's type is system.", type : 'boolean', length : 255, required : False, since : '4.20.0'}, {name : 'zoneid', description : 'The ID of zone of the Template', type : 'uuid', length : 255, required : False, related : 'listZones'}], response : [{}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'updateBackupSchedule', description : 'Updates a User-defined Instance backup schedule', since : '4.14.0', isasync : False, related : '', params : [{name : 'schedule', description : 'Custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28)', type : 'string', length : 255, required : True}, {name : 'intervaltype', description : 'Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY', type : 'string', length : 255, required : True}, {name : 'virtualmachineid', description : 'ID of the Instance for which schedule is to be defined', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'isolated', description : 'Whether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.', type : 'boolean', length : 255, required : False, since : '4.23.0'}, {name : 'quiescevm', description : 'Quiesce the Instance before checkpointing the disks for backup. Applicable only to NAS and KBOSS backup providers. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'timezone', description : 'Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.', type : 'string', length : 255, required : True}, {name : 'maxbackups', description : 'The maximum number of backups to keep for a VM. If "0", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.', type : 'integer', length : 255, required : False, since : '4.21.0'}], response : [{name : 'name', description : 'name of the backup', type : 'string'}, {name : 'validationstatus', description : 'Backup validation status.', type : 'validationstatus'}, {name : 'domain', description : 'Domain name', type : 'string'}, {name : 'accountid', description : 'Account id', type : 'string'}, {name : 'account', description : 'Account name', type : 'string'}, {name : 'domainid', description : 'Domain ID', type : 'string'}, {name : 'fromcheckpointid', description : 'Previous active checkpoint ID for incremental backups', type : 'string'}, {name : 'hostid', description : 'Host ID where the backup is running', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zone', description : 'Zone name', type : 'string'}, {name : 'virtualsize', description : 'Backup protected (virtual) size in bytes', type : 'long'}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'type', description : 'Backup type', type : 'string'}, {name : 'isbackupvmexpunged', description : 'Indicates whether the VM from which the backup was taken is expunged or not', type : 'boolean'}, {name : 'description', description : 'description for the backup', type : 'string'}, {name : 'backupofferingname', description : 'Backup offering name', type : 'string'}, {name : 'id', description : 'ID of the Instance backup', type : 'string'}, {name : 'volumes', description : 'Backed up volumes', type : 'string'}, {name : 'vmbackupofferingremoved', description : 'The backup offering corresponding to this backup was removed from the VM', type : 'boolean'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'created', description : 'Backup date', type : 'date'}, {name : 'intervaltype', description : 'Interval type of the backup', type : 'string'}, {name : 'status', description : 'Backup status', type : 'status'}, {name : 'externalid', description : 'External backup id', type : 'string'}, {name : 'size', description : 'Backup size in bytes', type : 'long'}, {name : 'uncompressedsize', description : 'Backup uncompressed size in bytes. Only defined if backup is compressed.', type : 'long'}, {name : 'compressionstatus', description : 'Backup compression status.', type : 'compressionstatus'}, {name : 'backupofferingid', description : 'Backup offering id', type : 'string'}, {name : 'vmdetails', description : 'Lists the vm specific details for the backup', type : 'map'}, {name : 'tocheckpointid', description : 'Next checkpoint ID for incremental backups', type : 'string'}], httprequesttype : 'POST'}, {name : 'createPrivateGateway', description : 'Creates a private gateway', since : '4.17.0', isasync : True, related : 'createPrivateGateway,listPrivateGateways', params : [{name : 'physicalnetworkid', description : 'The Physical Network ID the network belongs to', type : 'uuid', length : 255, required : False, related : 'listPhysicalNetworks,updatePhysicalNetwork'}, {name : 'bypassvlanoverlapcheck', description : 'When true bypasses VLAN id/range overlap check during private gateway creation', type : 'boolean', length : 255, required : False}, {name : 'netmask', description : 'The Netmask of the Private Gateway', type : 'string', length : 255, required : True}, {name : 'vpcid', description : 'The VPC Network belongs to', type : 'uuid', length : 255, required : True, related : 'listVPCs,createVPC,listVPCs,updateVPC'}, {name : 'gateway', description : 'The Gateway of the Private Gateway', type : 'string', length : 255, required : True}, {name : 'sourcenatsupported', description : "Source NAT supported value. Default value: false. When 'true', the source NAT is enabled on the private gateway 'false': sourcenat is not supported", type : 'boolean', length : 255, required : False}, {name : 'ipaddress', description : 'The IP address of the Private Gateway', type : 'string', length : 255, required : True}, {name : 'vlan', description : 'The network implementation uri for the private gateway', type : 'string', length : 255, required : False}, {name : 'networkofferingid', description : 'The UUID of the Network offering to use for the private gateways Network connection', type : 'uuid', length : 255, required : False, related : 'createNetworkOffering,updateNetworkOffering,listNetworkOfferings'}, {name : 'aclid', description : 'The ID of the Network ACL', type : 'uuid', length : 255, required : False, related : 'createNetworkACLList,listNetworkACLLists'}, {name : 'associatednetworkid', description : 'The Isolated Network this private gateway is associated to.', type : 'uuid', length : 255, required : False, since : '4.17.0', related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}], response : [{name : 'vpcid', description : 'VPC ID the private gateway belongs to', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'aclname', description : 'ACL name set for private gateway', type : 'string'}, {name : 'netmask', description : "The private gateway's netmask", type : 'string'}, {name : 'vlan', description : 'The Network implementation uri for the private gateway', type : 'string'}, {name : 'id', description : 'The ID of the private gateway', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'state', description : 'State of the gateway, can be Creating, Ready, Deleting', type : 'string'}, {name : 'project', description : 'The project name of the private gateway', type : 'string'}, {name : 'sourcenatsupported', description : 'Source Nat enable status', type : 'boolean'}, {name : 'ipaddress', description : "The private gateway's IP address", type : 'string'}, {name : 'associatednetworkid', description : 'The ID of the Network associated with this private gateway', type : 'string'}, {name : 'zoneid', description : 'Zone ID of the private gateway', type : 'string'}, {name : 'vpcname', description : 'VPC name the private gateway belongs to', type : 'string'}, {}, {name : 'aclid', description : 'ACL ID set for private gateway', type : 'string'}, {name : 'domain', description : 'The domain associated with the private gateway', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'projectid', description : 'The project ID of the private gateway', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the private gateway belongs', type : 'string'}, {name : 'gateway', description : 'The gateway', type : 'string'}, {name : 'associatednetwork', description : 'The name of the Network associated with this private gateway', type : 'string'}, {name : 'physicalnetworkid', description : 'The physical Network id', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the private gateway', type : 'string'}, {name : 'zonename', description : 'The name of the zone the private gateway belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the private gateway', type : 'string'}], httprequesttype : 'POST'}, {name : 'createVMFromBackup', description : 'Creates and automatically starts a VM from a backup.', since : '4.21.0', isasync : True, related : 'assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm', params : [{name : 'clusterid', description : 'destination Cluster ID to deploy the VM to - parameter available for root admin only', type : 'uuid', length : 255, required : False, since : '4.21', related : 'addCluster,updateCluster'}, {name : 'hypervisor', description : 'the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call', type : 'string', length : 255, required : False}, {name : 'ip6address', description : "the ipv6 address for default vm's network", type : 'string', length : 255, required : False}, {name : 'domainid', description : 'an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'zoneid', description : 'availability zone for the virtual machine', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'projectid', description : 'Deploy vm for the project', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'extraconfig', description : 'an optional URL encoded string that can be passed to the virtual machine upon successful deployment', type : 'string', length : 5120, required : False, since : '4.12'}, {name : 'password', description : 'The password of the virtual machine. If null, a random password will be generated for the VM.', type : 'string', length : 255, required : False, since : '4.19.0.0'}, {name : 'backupid', description : 'backup ID to create the VM from', type : 'uuid', length : 255, required : True, related : ''}, {name : 'customid', description : 'An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only', type : 'string', length : 255, required : False}, {name : 'nicpackedvirtqueuesenabled', description : 'Enable packed virtqueues or not.', type : 'boolean', length : 255, required : False, since : '4.18'}, {name : 'size', description : 'the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId', type : 'long', length : 255, required : False}, {name : 'keypair', description : 'name of the ssh key pair used to login to the virtual machine', type : 'string', length : 255, required : False}, {name : 'userdata', description : 'an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value', type : 'string', length : 1048576, required : False}, {name : 'dynamicscalingenabled', description : 'true if virtual machine needs to be dynamically scalable', type : 'boolean', length : 255, required : False, since : '4.16'}, {name : 'leaseduration', description : 'Number of days instance is leased for.', type : 'integer', length : 255, required : False, since : '4.21.0'}, {name : 'macaddress', description : "the mac address for default vm's network", type : 'string', length : 255, required : False}, {name : 'preserveip', description : 'Use the same IP/MAC addresses as stored in the backup metadata. Works only if the original Instance is deleted and the IP/MAC address is available.', type : 'boolean', length : 255, required : False}, {name : 'userdatadetails', description : 'used to specify the parameters values for the variables in userdata.', type : 'map', length : 255, required : False, since : '4.18'}, {name : 'keypairs', description : 'names of the ssh key pairs used to login to the virtual machine', type : 'list', length : 255, required : False, since : '4.17'}, {name : 'datadiskofferinglist', description : "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", type : 'map', length : 255, required : False, since : '4.11'}, {name : 'bootmode', description : 'Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.', type : 'string', length : 255, required : False, since : '4.14.0.0'}, {name : 'details', description : "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", type : 'map', length : 255, required : False, since : '4.3'}, {name : 'hostid', description : 'destination Host ID to deploy the VM to - parameter available for root admin only', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,listHosts,reconnectHost'}, {name : 'rootdisksize', description : 'Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided', type : 'long', length : 255, required : False, since : '4.4'}, {name : 'rootdiskkmskeyid', description : 'ID of the KMS Key to use for root disk encryption', type : 'uuid', length : 255, required : False, since : '4.23.0', related : 'createKMSKey,updateKMSKey'}, {name : 'bootintosetup', description : 'Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)', type : 'boolean', length : 255, required : False, since : '4.15.0.0'}, {name : 'keyboard', description : 'an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,es-latam,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us', type : 'string', length : 255, required : False}, {name : 'iothreadsenabled', description : 'IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.', type : 'boolean', length : 255, required : False}, {name : 'networkids', description : "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", type : 'list', length : 255, required : False, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}, {name : 'displayvm', description : 'an optional field, whether to the display the vm to the end user or not.', type : 'boolean', length : 255, required : False, since : '4.2'}, {name : 'copyimagetags', description : 'if true the image tags (if any) will be copied to the VM, default value is false', type : 'boolean', length : 255, required : False, since : '4.13'}, {name : 'ipaddress', description : "the ip address for default vm's network", type : 'string', length : 255, required : False}, {name : 'properties', description : 'used to specify the vApp properties.', type : 'map', length : 255, required : False, since : '4.15'}, {name : 'nicmultiqueuenumber', description : 'The number of queues for multiqueue NICs.', type : 'integer', length : 255, required : False, since : '4.18'}, {name : 'group', description : 'an optional group for the virtual machine', type : 'string', length : 255, required : False}, {name : 'securitygroupnames', description : 'comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter', type : 'list', length : 255, required : False, related : 'updateSecurityGroup'}, {name : 'leaseexpiryaction', description : 'Lease expiry action, valid values are STOP and DESTROY', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'affinitygroupids', description : 'comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter', type : 'list', length : 255, required : False, related : 'createAffinityGroup,listAffinityGroups'}, {name : 'externaldetails', description : 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'securitygroupids', description : 'comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter', type : 'list', length : 255, required : False, related : 'updateSecurityGroup'}, {name : 'boottype', description : 'Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.', type : 'string', length : 255, required : False, since : '4.14.0.0'}, {name : 'iptonetworklist', description : "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", type : 'map', length : 255, required : False}, {name : 'dhcpoptionsnetworklist', description : 'DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com', type : 'map', length : 255, required : False}, {name : 'iodriverpolicy', description : 'Controls specific policies on IO', type : 'string', length : 255, required : False}, {name : 'userdataid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.18', related : 'listCniConfiguration'}, {name : 'account', description : 'an optional account for the virtual machine. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'templateid', description : 'the ID of the template for the virtual machine', type : 'uuid', length : 255, required : False, related : 'prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'startvm', description : 'true if start vm after creating; defaulted to true if not specified', type : 'boolean', length : 255, required : False}, {name : 'deploymentplanner', description : 'Deployment planner to use for vm allocation. Available to ROOT admin only', type : 'string', length : 255, required : False, since : '4.4'}, {name : 'podid', description : 'destination Pod ID to deploy the VM to - parameter available for root admin only', type : 'uuid', length : 255, required : False, since : '4.21', related : 'createPod,listPods,createManagementNetworkIpRange'}, {name : 'quickrestore', description : 'Whether to use the quick restore process or not. Currently this parameter is only supported by the KBOSS provider.', type : 'boolean', length : 255, required : False, since : '4.23.0', related : ''}, {name : 'name', description : 'host name for the virtual machine', type : 'string', length : 255, required : False}, {name : 'affinitygroupnames', description : 'comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter', type : 'list', length : 255, required : False, related : 'createAffinityGroup,listAffinityGroups'}, {name : 'nicnetworklist', description : 'VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid', type : 'map', length : 255, required : False, since : '4.15'}, {name : 'datadisksdetails', description : 'Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200&datadisksdetails[0].kmskeyid=<uuid>', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'displayname', description : 'an optional user generated name for the virtual machine', type : 'string', length : 255, required : False}, {name : 'serviceofferingid', description : 'the ID of the service offering for the virtual machine', type : 'uuid', length : 255, required : False, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'diskofferingid', description : 'the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'overridediskofferingid', description : 'the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id', type : 'uuid', length : 255, required : False, since : '4.17', related : ''}], response : [{name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}]}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}]}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}]}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}]}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}]}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}]}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'id', description : 'The ID of the attached ISO', type : 'string'}]}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {}], httprequesttype : 'POST'}, {name : 'updateVMSchedule', description : 'Update Instance Schedule.', since : '4.19.0', isasync : False, related : '', params : [{name : 'startdate', description : 'Start date from which the schedule becomes active(Format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'schedule', description : "Schedule for action on Instance in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", type : 'string', length : 255, required : False}, {name : 'description', description : 'Name of the schedule', type : 'string', length : 255, required : False}, {name : 'enddate', description : 'End date after which the schedule becomes inactive(Format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'timezone', description : 'Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.', type : 'string', length : 255, required : False}, {name : 'enabled', description : 'Enable Instance schedule', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'ID of Instance schedule', type : 'uuid', length : 255, required : True, related : 'updateVMSchedule'}], response : [{name : 'action', description : 'Action', type : 'action'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'virtualmachineid', description : 'ID of Instance', type : 'string'}, {name : 'schedule', description : 'Cron formatted Instance schedule', type : 'string'}, {}, {name : 'description', description : 'Description of Instance schedule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'enabled', description : 'VM schedule is enabled', type : 'boolean'}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'id', description : 'The ID of Instance schedule', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'listGpuDevices', description : 'Lists all available GPU devices', since : '4.21.0', isasync : False, related : 'listGpuDevices,discoverGpuDevices,createGpuDevice', params : [{name : 'id', description : 'ID of the GPU device', type : 'uuid', length : 255, required : False, related : 'listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'virtualmachineid', description : 'the virtual machine ID to which the GPU device is allocated', type : 'uuid', length : 255, required : False, related : 'assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'gpucardid', description : 'the GPU card ID associated with the GPU device', type : 'uuid', length : 255, required : False, related : 'listGpuCards'}, {name : 'hostid', description : 'the host ID where the GPU device is attached', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,listHosts,reconnectHost'}, {name : 'vgpuprofileid', description : 'the vGPU profile ID assigned to the GPU device', type : 'uuid', length : 255, required : False, related : 'createVgpuProfile,updateVgpuProfile'}], response : [{name : 'virtualmachineid', description : 'the vGPU profile ID assigned to this GPU device', type : 'string'}, {name : 'numanode', description : 'the NUMA node where the GPU device is located', type : 'string'}, {name : 'managedstate', description : 'the managed state of the GPU device (Enabled/Disabled)', type : 'managedstate'}, {name : 'gpucardname', description : 'the GPU card name associated with this GPU device', type : 'string'}, {name : 'vgpuprofileid', description : 'the vGPU profile ID assigned to this GPU device', type : 'string'}, {name : 'virtualmachinename', description : 'the vGPU profile name assigned to this GPU device', type : 'string'}, {name : 'gpudevicetype', description : 'bus address of the GPU device', type : 'devicetype'}, {name : 'state', description : 'the vGPU profile name assigned to this GPU device', type : 'state'}, {name : 'vmstate', description : 'the state of the virtual machine to which this GPU device is allocated', type : 'state'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'the ID of the GPU device', type : 'string'}, {}, {name : 'busaddress', description : 'bus address of the GPU device or MDEV UUID for vGPU devices', type : 'string'}, {name : 'hostid', description : 'the host ID where the GPU device is attached', type : 'string'}, {name : 'gpucardid', description : 'the GPU card ID associated with this GPU device', type : 'string'}, {name : 'parentgpudeviceid', description : 'the ID of the parent GPU device, if this is a vGPU', type : 'string'}, {}, {name : 'hostname', description : 'the host name where the GPU device is attached', type : 'string'}, {name : 'vgpuprofilename', description : 'the vGPU profile name assigned to this GPU device', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'assignVirtualMachineToBackupOffering', description : 'Assigns an Instance to a backup offering', since : '4.14.0', isasync : True, params : [{name : 'virtualmachineid', description : 'ID of the  Instance', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'backupofferingid', description : 'ID of the backup offering', type : 'uuid', length : 255, required : True, related : 'listBackupOfferings,updateBackupOffering,createBackupOffering'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'listResourceIcon', description : 'Lists the resource icon for the specified resource(s)', since : '4.16.0.0', isasync : False, related : '', params : [{name : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : True}, {name : 'resourceids', description : 'List of resources to upload the icon/image for', type : 'list', length : 255, required : True}], response : [{name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'base64image', description : 'Base64 representation of resource icon', type : 'string'}, {}, {name : 'resourcetype', description : 'Resource type', type : 'resourceobjecttype'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'listVirtualMachinesMetrics', description : 'Lists VM metrics', isasync : False, related : 'listVirtualMachinesMetrics', params : [{name : 'keypair', description : 'List Instances by SSH keypair name', type : 'string', length : 255, required : False}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'securitygroupid', description : 'The security group ID', type : 'uuid', length : 255, required : False, since : '4.15', related : 'updateSecurityGroup'}, {name : 'vpcid', description : 'List Instances by VPC', type : 'uuid', length : 255, required : False, related : 'listVPCs,createVPC,listVPCs,updateVPC'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string', length : 255, required : False, since : '4.20.1'}, {name : 'affinitygroupid', description : 'List Instances by affinity group', type : 'uuid', length : 255, required : False, related : 'createAffinityGroup,listAffinityGroups'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'name', description : 'Name of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'isvnf', description : 'flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.', type : 'boolean', length : 255, required : False, since : '4.19.0'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'extensionid', description : 'The ID of the Orchestrator extension for the VM', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension'}, {name : 'hypervisor', description : 'The target hypervisor for the Template', type : 'string', length : 255, required : False}, {name : 'hostid', description : 'The host ID', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,listHosts,reconnectHost'}, {name : 'accumulate', description : 'Accumulates the Instance metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.', type : 'boolean', length : 255, required : False, since : '4.17.0'}, {name : 'userdata', description : "Whether to return the Instances' User data or not. By default, User data will not be returned.", type : 'boolean', length : 255, required : False, since : '4.18.0.0'}, {name : 'leased', description : 'Whether to return only leased instances', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'autoscalevmgroupid', description : 'The ID of AutoScaling Instance Group', type : 'uuid', length : 255, required : False, since : '4.18.0', related : 'enableAutoScaleVmGroup'}, {name : 'id', description : 'The ID of the Instance', type : 'uuid', length : 255, required : False, related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'backupofferingid', description : 'List by the backup offering', type : 'uuid', length : 255, required : False, since : '4.17', related : 'listBackupOfferings,updateBackupOffering,createBackupOffering'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'groupid', description : 'The group ID', type : 'uuid', length : 255, required : False, related : 'updateInstanceGroup'}, {name : 'state', description : 'State of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.', type : 'string', length : 255, required : False}, {name : 'details', description : 'Comma separated list of Instance details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.', type : 'list', length : 255, required : False}, {name : 'forvirtualnetwork', description : 'List by Network type; true if need to list Instances using Virtual Network, false otherwise', type : 'boolean', length : 255, required : False}, {name : 'gpuenabled', description : 'Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'showicon', description : 'Flag to display the resource icon for Instances', type : 'boolean', length : 255, required : False, since : '4.16.0.0'}, {name : 'displayvm', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'storageid', description : "The storage ID where vm's volumes belong to", type : 'uuid', length : 255, required : False, related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}, {name : 'zoneid', description : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'haenable', description : 'List by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabled', type : 'boolean', length : 255, required : False, since : '4.15'}, {name : 'templateid', description : 'List Instances by Template', type : 'uuid', length : 255, required : False, related : 'prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'ids', description : 'The IDs of the Instances, mutually exclusive with id', type : 'list', length : 255, required : False, since : '4.4', related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'userid', description : 'The user ID that created the Instance and is under the Account that owns the Instance', type : 'uuid', length : 255, required : False, related : 'disableUser,getUser,listUsers,lockUser'}, {name : 'isoid', description : 'List Instances by ISO', type : 'uuid', length : 255, required : False}, {name : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}, {name : 'podid', description : 'The pod ID', type : 'uuid', length : 255, required : False, related : 'listPods,createManagementNetworkIpRange'}, {name : 'clusterid', description : 'The cluster ID', type : 'uuid', length : 255, required : False, related : 'addCluster,updateCluster'}, {name : 'serviceofferingid', description : 'List by the service offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", type : 'boolean', length : 255, required : False}, {name : 'userdataid', description : 'the instances by userdata', type : 'uuid', length : 255, required : False, since : '4.20.1', related : 'listCniConfiguration'}], response : [{name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}]}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}]}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}]}]}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}]}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'diskwrite', description : 'Disk write in MiB', type : 'string'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}]}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'name', description : 'The name of the attached ISO', type : 'string'}]}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'networkwrite', description : 'Network write in MiB', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'networkread', description : 'Network read in MiB', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'diskiopstotal', description : 'The total disk iops', type : 'long'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'memorytotal', description : 'The total memory capacity in GiB', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'diskread', description : 'Disk read in MiB', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'cputotal', description : 'The total cpu capacity in Ghz', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}], httprequesttype : 'GET'}, {name : 'releaseIpAddress', description : 'Releases an IP address from the Account.', since : '4.17', isasync : False, params : [{name : 'id', description : 'The ID of the public IP address to release', type : 'uuid', length : 255, required : True, related : 'associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses'}], response : [{}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'reserveIpAddress', description : 'Reserve a public IP to an Account.', since : '4.17', isasync : False, related : 'associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses', params : [{name : 'projectid', description : 'The ID of the project to reserve with this IP address', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'domainid', description : 'The ID of the domain to reserve with this IP address', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'id', description : 'The ID of the public IP address to reserve', type : 'uuid', length : 255, required : True, related : 'associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses'}, {name : 'account', description : 'The Account to reserve with this IP address', type : 'string', length : 255, required : False}, {name : 'fordisplay', description : 'An optional field, whether to the display the IP to the end User or not', type : 'boolean', length : 255, required : False}], response : [{name : 'vpcid', description : 'VPC ID the IP belongs to', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the public IP address belongs', type : 'string'}, {name : 'state', description : 'State of the IP address. Can be: Allocating, Allocated, Releasing, Reserved and Free', type : 'string'}, {name : 'forsystemvms', description : 'true if range is dedicated for System VMs', type : 'boolean'}, {name : 'id', description : 'Public IP address ID', type : 'string'}, {name : 'project', description : 'The project name of the address', type : 'string'}, {name : 'domain', description : 'The domain the public IP address is associated with', type : 'string'}, {name : 'vpcname', description : 'VPC name the IP belongs to', type : 'string'}, {name : 'purpose', description : 'Purpose of the IP address. In Acton this value is not null for IPs with isSystem=true, and can have either StaticNat or LB value', type : 'string'}, {name : 'isstaticnat', description : 'True if this IP is for static NAT, false otherwise', type : 'boolean'}, {name : 'issourcenat', description : 'True if the IP address is a source NAT address, false otherwise', type : 'boolean'}, {name : 'virtualmachinename', description : 'Instance name the IP address is assigned to', type : 'string'}, {name : 'physicalnetworkid', description : 'The physical Network this belongs to', type : 'string'}, {name : 'issystem', description : 'True if this IP is system IP (was allocated as a part of deployVm or createLbRule)', type : 'boolean'}, {name : 'networkid', description : 'The ID of the Network where IP belongs to', type : 'string'}, {name : 'ipaddress', description : 'Public IP address', type : 'string'}, {name : 'isportable', description : 'Is public IP portable across the zones', type : 'boolean'}, {name : 'networkname', description : 'The name of the Network where IP belongs to', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'account', description : 'The Account the public IP address is associated with', type : 'string'}, {name : 'vlanid', description : 'The ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only', type : 'string'}, {name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {name : 'vmipaddress', description : 'Instance (DNAT) IP address (not null only for static NAT IP)', type : 'string'}, {name : 'vlanname', description : 'The VLAN associated with the IP address', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the Network associated with the IP address', type : 'string'}, {name : 'zoneid', description : 'The ID of the zone the public IP address belongs to', type : 'string'}, {name : 'associatednetworkid', description : 'The ID of the Network associated with the IP address', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the IP address', type : 'boolean'}, {name : 'tags', description : 'The list of resource tags associated with IP address', type : 'list', response : [{name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'virtualmachinetype', description : 'Instance type the IP address is assigned to', type : 'string'}, {name : 'hasrules', description : 'Whether the IP address has Firewall/PortForwarding/LoadBalancing rules defined', type : 'boolean'}, {name : 'fordisplay', description : 'Is public IP for display to the regular user', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainid', description : 'The domain ID the public IP address is associated with', type : 'string'}, {name : 'forprovider', description : 'true if range is dedicated for external network providers', type : 'boolean'}, {name : 'virtualmachinedisplayname', description : 'Instance display name the IP address is assigned to (not null only for static NAT IP)', type : 'string'}, {name : 'zonename', description : 'The name of the zone the public IP address belongs to', type : 'string'}, {name : 'virtualmachineid', description : 'Instance id the IP address is assigned to', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {}, {name : 'allocated', description : 'Date the public IP address was acquired', type : 'date'}], httprequesttype : 'POST'}, {name : 'deleteVMSchedule', description : 'Delete Instance Schedule.', since : '4.19.0', isasync : False, params : [{name : 'virtualmachineid', description : 'ID of Instance', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'id', description : 'ID of Instance schedule', type : 'uuid', length : 255, required : False, related : ''}, {name : 'ids', description : 'IDs of Instance schedule', type : 'list', length : 255, required : False, related : ''}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'deleteDnsRecord', description : 'Deletes a DNS record from the external provider', since : '4.23.0', isasync : True, params : [{name : 'dnszoneid', description : 'The ID of the DNS zone', type : 'uuid', length : 255, required : True, related : 'listDnsZones'}, {name : 'name', description : '', type : 'string', length : 255, required : True}, {name : 'type', description : '', type : 'string', length : 255, required : True}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'destroySharedFileSystem', description : 'Destroy a Shared FileSystem by id', since : '4.20.0', isasync : True, params : [{name : 'id', description : 'the ID of the shared filesystem to delete', type : 'uuid', length : 255, required : False, related : 'listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}, {name : 'expunge', description : 'If true is passed, the shared filesystem is expunged immediately. False by default.', type : 'boolean', length : 255, required : False}, {name : 'forced', description : 'If true is passed, the shared filesystem can be destroyed without stopping it first.', type : 'boolean', length : 255, required : False}], response : [{}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'listProjectRolePermissions', description : "Lists a project's project role permissions", since : '4.15.0', isasync : False, related : '', params : [{name : 'projectid', description : 'ID of the project', type : 'uuid', length : 255, required : True, related : 'createProject'}, {name : 'projectroleid', description : 'ID of the project role', type : 'uuid', length : 255, required : False, related : 'listProjectRoles,updateProjectRole'}], response : [{}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'permission', description : 'The permission type of the api name or wildcard rule, allow/deny', type : 'string'}, {name : 'description', description : 'The description of the role permission', type : 'string'}, {name : 'projectroleid', description : 'The ID of the project role to which the role permission belongs', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'rule', description : 'The api name or wildcard rule', type : 'string'}, {name : 'projectrolename', description : 'The name of the project role to which the role permission belongs', type : 'string'}, {name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'id', description : 'The ID of the project role permission', type : 'string'}], httprequesttype : 'GET'}, {name : 'createBucket', description : 'Creates a bucket in the specified object storage pool. ', since : '4.19.0', isasync : True, related : 'listBuckets', params : [{name : 'quota', description : 'Bucket Quota in GiB', type : 'integer', length : 255, required : True}, {name : 'policy', description : 'The Bucket access policy', type : 'string', length : 255, required : False}, {name : 'objectstorageid', description : 'Id of the Object Storage Pool where bucket is created', type : 'uuid', length : 255, required : True, related : 'addObjectStoragePool'}, {name : 'encryption', description : 'Enable bucket encryption', type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'the domain ID associated with the bucket. If used with the account parameter returns the bucket associated with the account for the specified domain.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'projectid', description : 'the project associated with the bucket. Mutually exclusive with account parameter', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'objectlocking', description : 'Enable object locking in bucket', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'the name of the bucket', type : 'string', length : 255, required : True}, {name : 'account', description : 'the account associated with the bucket. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'versioning', description : 'Enable bucket versioning', type : 'boolean', length : 255, required : False}], response : [{name : 'domainid', description : 'the ID of the domain associated with the bucket', type : 'string'}, {name : 'provider', description : 'Object storage provider', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'domain', description : 'the domain associated with the bucket', type : 'string'}, {name : 'name', description : 'name of the Bucket', type : 'string'}, {}, {name : 'size', description : 'Total size of objects in Bucket', type : 'long'}, {name : 'project', description : 'the project name of the bucket', type : 'string'}, {name : 'versioning', description : 'Bucket Versioning', type : 'boolean'}, {name : 'url', description : 'Bucket URL', type : 'string'}, {name : 'objectlocking', description : 'Bucket Object Locking', type : 'boolean'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'domainpath', description : 'path of the domain to which the bucket belongs', type : 'string'}, {name : 'projectid', description : 'the project id of the bucket', type : 'string'}, {name : 'usersecretkey', description : 'Bucket Secret Key', type : 'string'}, {}, {name : 'objectstorageid', description : 'id of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'created', description : 'the date the Bucket was created', type : 'date'}, {name : 'state', description : 'State of the Bucket', type : 'string'}, {name : 'quota', description : 'Bucket Quota in GiB', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'objectstore', description : 'Name of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'accesskey', description : 'Bucket Access Key', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'ID of the Bucket', type : 'string'}, {name : 'account', description : 'the account associated with the Bucket', type : 'string'}, {name : 'encryption', description : 'Bucket Encryption', type : 'boolean'}, {name : 'policy', description : 'Bucket Access Policy', type : 'string'}], httprequesttype : 'POST'}, {name : 'listRoutingFirewallRules', description : 'Lists all Routing firewall rules', since : '4.20.0', isasync : False, related : 'createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule', params : [{name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'id', description : 'Lists Routing firewall rule with the specified ID', type : 'uuid', length : 255, required : False, related : 'listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'traffictype', description : 'list Routing firewall rules by traffic type - ingress or egress', type : 'string', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'fordisplay', description : 'list resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'networkid', description : 'list Routing firewall rules by network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}], response : [{name : 'id', description : 'The ID of the port forwarding rule', type : 'string'}, {name : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID for the port forwarding rule', type : 'string'}, {name : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}, {name : 'state', description : 'The state of the rule', type : 'string'}, {name : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {name : 'virtualmachinedisplayname', description : 'The Instance display name for the port forwarding rule', type : 'string'}, {name : 'privateport', description : "The starting port of port forwarding rule's private port range", type : 'string'}, {}, {name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', type : 'string'}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'privateendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'list', response : [{name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'networkid', description : 'The ID of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {name : 'publicport', description : "The starting port of port forwarding rule's public port range", type : 'string'}, {}], httprequesttype : 'GET'}, {name : 'addVirtualMachinesToKubernetesCluster', description : 'Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.', since : '4.19.0', isasync : False, params : [{name : 'iscontrolnode', description : 'Is control node or not? Defaults to false.', type : 'boolean', length : 255, required : False}, {name : 'virtualmachineids', description : 'The IDs of the VMs to add to the cluster', type : 'list', length : 255, required : True, related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,updateKubernetesClusterAffinityGroups'}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'listBackupOfferings', description : 'Lists backup offerings', since : '4.14.0', isasync : False, related : 'updateBackupOffering,createBackupOffering', params : [{name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'zoneid', description : 'The zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The backup offering ID', type : 'uuid', length : 255, required : False, related : 'listBackupOfferings,updateBackupOffering,createBackupOffering'}], response : [{name : 'name', description : 'Name for the backup offering', type : 'string'}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'provider', description : 'provider name', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'crosszoneinstancecreation', description : 'the backups with this offering can be used to create Instances on all Zones', type : 'boolean'}, {name : 'backupofferingdetails', description : 'Details for the backup offering', type : 'map'}, {}, {name : 'allowuserdrivenbackups', description : 'Whether the offering allows User driven ad-hoc/scheduled backups', type : 'boolean'}, {name : 'externalid', description : 'External ID on the provider side', type : 'string'}, {name : 'zonename', description : 'Zone name', type : 'string'}, {}, {name : 'created', description : 'The date this backup offering was created', type : 'date'}, {name : 'domainid', description : 'the domain ID(s) this backup offering belongs to.', type : 'string'}, {name : 'id', description : 'ID of the backup offering', type : 'string'}, {name : 'domain', description : 'the domain name(s) this backup offering belongs to.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'description', description : 'Description for the backup offering', type : 'string'}], httprequesttype : 'GET'}, {name : 'listVnfTemplates', description : 'List all public, private, and privileged VNF templates.', since : '4.19.0', isasync : False, related : 'prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate', params : [{name : 'isready', description : 'list templates that are ready to be deployed', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'showremoved', description : 'Show removed Templates as well', type : 'boolean', length : 255, required : False}, {name : 'showicon', description : 'Flag to display the resource image for the Templates', type : 'boolean', length : 255, required : False}, {name : 'zoneid', description : 'List Templates by zoneId', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'details', description : 'Comma separated list of Template details requested, value can be a list of [all, min]', type : 'list', length : 255, required : False, since : '4.15'}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'name', description : 'The Template name', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'forcks', description : 'list templates that can be used to deploy CKS clusters', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'templatetype', description : 'the type of the template', type : 'string', length : 255, required : False, since : '4.19.0'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'parenttemplateid', description : 'List datadisk Templates by parent Template id', type : 'uuid', length : 255, required : False, since : '4.4', related : 'prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'arch', description : 'the CPU arch of the template. Valid options are: x86_64, aarch64, s390x', type : 'string', length : 255, required : False, since : '4.20'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'id', description : 'The Template ID', type : 'uuid', length : 255, required : False, related : 'prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'templatefilter', description : 'Possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : Templates that have been marked as featured and public. * self : Templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns Templates that can be used to deploy a new Instance. * sharedexecutable : Templates ready to be deployed that have been granted to the calling user by another user. * executable : Templates that are owned by the calling user, or public Templates, that can be used to deploy an Instance. * community : Templates that have been marked as public but not featured. * all : all Templates (only usable by admins).', type : 'string', length : 255, required : True}, {name : 'isvnf', description : 'flag to list VNF templates or not; true if need to list VNF templates, false otherwise.', type : 'boolean', length : 255, required : False, since : '4.19.0'}, {name : 'ids', description : 'The IDs of the Templates, mutually exclusive with id', type : 'list', length : 255, required : False, since : '4.9', related : 'prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'extensionid', description : 'ID of the extension for the template', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listExtensions,deleteExtension,updateExtension,unregisterExtension'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'hypervisor', description : 'The hypervisor for which to restrict the search', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'showunique', description : 'If set to true, list only unique Templates across zones', type : 'boolean', length : 255, required : False, since : '4.13.2'}, {name : 'oscategoryid', description : 'the ID of the OS category for the template', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listOsCategories'}], response : [{name : 'format', description : 'The format of the Template.', type : 'imageformat'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {}, {name : 'checksum', description : 'Checksum of the Template', type : 'string'}, {}, {name : 'userdataparams', description : 'List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata', type : 'string'}, {name : 'id', description : 'The Template ID', type : 'string'}, {name : 'userdataid', description : 'The id of userdata linked to this Template', type : 'string'}, {name : 'project', description : 'The project name of the Template', type : 'string'}, {name : 'deployasis', description : 'VMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.', type : 'boolean'}, {name : 'extensionid', description : 'The ID of extension linked to this template', type : 'string'}, {name : 'isready', description : 'True if the Template is ready to be deployed from, false otherwise.', type : 'boolean'}, {name : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'crossZones', description : 'True if the Template is managed across all Zones, false otherwise', type : 'boolean'}, {name : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {name : 'url', description : 'The URL which the Template/ISO is registered from', type : 'string'}, {name : 'extensionname', description : 'The name of extension linked to this template', type : 'string'}, {name : 'requireshvm', description : 'True if Template requires HVM enabled, false otherwise', type : 'boolean'}, {name : 'accountid', description : 'The Account id to which the Template belongs', type : 'string'}, {name : 'sourcetemplateid', description : 'The Template ID of the parent Template if present', type : 'string'}, {name : 'removed', description : 'The date this Template was removed', type : 'date'}, {name : 'hostname', description : 'The name of the secondary storage host for the Template', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean'}, {name : 'domainid', description : 'The ID of the domain to which the Template belongs', type : 'string'}, {name : 'sshkeyenabled', description : 'True if Template is sshkey enabled, false otherwise', type : 'boolean'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'templatetag', description : 'The tag of this Template', type : 'string'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'zonename', description : 'The name of the zone for this Template', type : 'string'}, {name : 'directdownload', description : 'KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage', type : 'boolean'}, {name : 'passwordenabled', description : 'True if the reset password feature is enabled, false otherwise', type : 'boolean'}, {name : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'parenttemplateid', description : 'If Datadisk Template, then id of the root disk Template this Template belongs to', type : 'string'}, {name : 'account', description : 'The Account name to which the Template belongs', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', type : 'string'}, {name : 'arch', description : 'CPU Arch of the template', type : 'string'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'bits', description : 'The processor bit size', type : 'int'}, {name : 'ostypeid', description : 'The ID of the OS type for this Template.', type : 'string'}, {name : 'hostid', description : 'The ID of the secondary storage host for the Template', type : 'string'}, {}, {name : 'userdataname', description : 'The name of userdata linked to this Template', type : 'string'}, {name : 'isextractable', description : 'True if the Template is extractable, false otherwise', type : 'boolean'}, {name : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean'}, {name : 'status', description : 'The status of the Template', type : 'string'}, {name : 'templatetype', description : 'The type of the Template', type : 'string'}, {name : 'size', description : 'The size of the Template', type : 'long'}, {name : 'domain', description : 'The name of the domain to which the Template belongs', type : 'string'}, {name : 'displaytext', description : 'The Template display text', type : 'string'}, {name : 'name', description : 'The Template name', type : 'string'}, {name : 'ispublic', description : 'True if this Template is a public Template, false otherwise', type : 'boolean'}], httprequesttype : 'GET'}, {name : 'deployVnfAppliance', description : 'Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.', since : '4.19.0', isasync : True, related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm', params : [{name : 'iodriverpolicy', description : 'Controls specific policies on IO', type : 'string', length : 255, required : False}, {name : 'serviceofferingid', description : 'The ID of the Service offering for the Instance', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'templateid', description : 'The ID of the Template for the Instance', type : 'uuid', length : 255, required : False, related : 'prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'datadiskofferinglist', description : "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", type : 'map', length : 255, required : False, since : '4.11'}, {name : 'macaddress', description : "the mac address for default vm's network", type : 'string', length : 255, required : False}, {name : 'ip6address', description : "the ipv6 address for default vm's network", type : 'string', length : 255, required : False}, {name : 'affinitygroupnames', description : 'comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter', type : 'list', length : 255, required : False, related : ''}, {name : 'vnfconfiguremanagement', description : 'False by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. True otherwise. Network rules are configured if management network is an isolated network or shared network with security groups.', type : 'boolean', length : 255, required : False}, {name : 'displayname', description : 'an optional user generated name for the virtual machine', type : 'string', length : 255, required : False}, {name : 'keyboard', description : 'an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,es-latam,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us', type : 'string', length : 255, required : False}, {name : 'boottype', description : 'Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.', type : 'string', length : 255, required : False, since : '4.14.0.0'}, {name : 'keypair', description : 'name of the ssh key pair used to login to the virtual machine', type : 'string', length : 255, required : False}, {name : 'leaseexpiryaction', description : 'Lease expiry action, valid values are STOP and DESTROY', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'iptonetworklist', description : "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", type : 'map', length : 255, required : False}, {name : 'userdata', description : 'an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value', type : 'string', length : 1048576, required : False}, {name : 'affinitygroupids', description : 'comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter', type : 'list', length : 255, required : False, related : ''}, {name : 'ipaddress', description : "the ip address for default vm's network", type : 'string', length : 255, required : False}, {name : 'extraconfig', description : 'an optional URL encoded string that can be passed to the virtual machine upon successful deployment', type : 'string', length : 5120, required : False, since : '4.12'}, {name : 'vnfcidrlist', description : 'the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0.', type : 'list', length : 255, required : False}, {name : 'rootdisksize', description : 'Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided', type : 'long', length : 255, required : False, since : '4.4'}, {name : 'rootdiskkmskeyid', description : 'ID of the KMS Key to use for root disk encryption', type : 'uuid', length : 255, required : False, since : '4.23.0', related : 'createKMSKey,updateKMSKey'}, {name : 'customid', description : 'An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only', type : 'string', length : 255, required : False}, {name : 'copyimagetags', description : 'if true the image tags (if any) will be copied to the VM, default value is false', type : 'boolean', length : 255, required : False, since : '4.13'}, {name : 'nicpackedvirtqueuesenabled', description : 'Enable packed virtqueues or not.', type : 'boolean', length : 255, required : False, since : '4.18'}, {name : 'deploymentplanner', description : 'Deployment planner to use for vm allocation. Available to ROOT admin only', type : 'string', length : 255, required : False, since : '4.4'}, {name : 'zoneid', description : 'availability zone for the virtual machine', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'diskofferingid', description : 'the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'domainid', description : 'an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'details', description : "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", type : 'map', length : 255, required : False, since : '4.3'}, {name : 'volumeid', description : '', type : 'uuid', length : 255, required : False, since : '4.21', related : 'createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}, {name : 'startvm', description : 'true if start vm after creating; defaulted to true if not specified', type : 'boolean', length : 255, required : False}, {name : 'dhcpoptionsnetworklist', description : 'DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com', type : 'map', length : 255, required : False}, {name : 'iothreadsenabled', description : 'IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.', type : 'boolean', length : 255, required : False}, {name : 'nicmultiqueuenumber', description : 'The number of queues for multiqueue NICs.', type : 'integer', length : 255, required : False, since : '4.18'}, {name : 'bootmode', description : 'Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.', type : 'string', length : 255, required : False, since : '4.14.0.0'}, {name : 'hostid', description : 'destination Host ID to deploy the VM to - parameter available for root admin only', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,reconnectHost'}, {name : 'password', description : 'The password of the virtual machine. If null, a random password will be generated for the VM.', type : 'string', length : 255, required : False, since : '4.19.0.0'}, {name : 'userdataid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.18', related : 'listCniConfiguration'}, {name : 'group', description : 'an optional group for the virtual machine', type : 'string', length : 255, required : False}, {name : 'externaldetails', description : 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'size', description : 'the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId', type : 'long', length : 255, required : False}, {name : 'networkids', description : "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", type : 'list', length : 255, required : False, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}, {name : 'securitygroupids', description : 'comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter', type : 'list', length : 255, required : False, related : 'updateSecurityGroup'}, {name : 'hypervisor', description : 'the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call', type : 'string', length : 255, required : False}, {name : 'name', description : 'host name for the virtual machine', type : 'string', length : 255, required : False}, {name : 'snapshotid', description : '', type : 'uuid', length : 255, required : False, since : '4.21', related : 'createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots'}, {name : 'properties', description : 'used to specify the vApp properties.', type : 'map', length : 255, required : False, since : '4.15'}, {name : 'securitygroupnames', description : 'comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter', type : 'list', length : 255, required : False, related : 'updateSecurityGroup'}, {name : 'displayvm', description : 'an optional field, whether to the display the vm to the end user or not.', type : 'boolean', length : 255, required : False, since : '4.2'}, {name : 'keypairs', description : 'names of the ssh key pairs used to login to the virtual machine', type : 'list', length : 255, required : False, since : '4.17'}, {name : 'leaseduration', description : 'Number of days instance is leased for.', type : 'integer', length : 255, required : False, since : '4.21.0'}, {name : 'dynamicscalingenabled', description : 'true if virtual machine needs to be dynamically scalable', type : 'boolean', length : 255, required : False, since : '4.16'}, {name : 'datadisksdetails', description : 'Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200&datadisksdetails[0].kmskeyid=<uuid>', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'userdatadetails', description : 'used to specify the parameters values for the variables in userdata.', type : 'map', length : 255, required : False, since : '4.18'}, {name : 'account', description : 'an optional account for the virtual machine. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'overridediskofferingid', description : 'the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id', type : 'uuid', length : 255, required : False, since : '4.17', related : ''}, {name : 'bootintosetup', description : 'Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)', type : 'boolean', length : 255, required : False, since : '4.15.0.0'}, {name : 'nicnetworklist', description : 'VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid', type : 'map', length : 255, required : False, since : '4.15'}, {name : 'projectid', description : 'Deploy vm for the project', type : 'uuid', length : 255, required : False, related : 'createProject'}], response : [{name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}]}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}]}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}]}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}]}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}]}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}]}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}]}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}], httprequesttype : 'POST'}, {name : 'stopKubernetesCluster', description : 'Stops a running CloudManaged Kubernetes cluster', isasync : True, params : [{name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,updateKubernetesClusterAffinityGroups'}], response : [{}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'startSharedFileSystem', description : 'Start a Shared FileSystem', since : '4.20.0', isasync : True, related : 'listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering', params : [{name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}], response : [{name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}]}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'associateDnsZoneToNetwork', description : 'Associates a DNS Zone with a Network for VM auto-registration', since : '4.23.0', isasync : False, related : '', params : [{name : 'networkid', description : 'The ID of the network', type : 'uuid', length : 255, required : True, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}, {name : 'subdomain', description : "Optional subdomain to append (e.g., 'dev' creates vm1.dev.example.com)", type : 'string', length : 255, required : False}, {name : 'dnszoneid', description : 'The ID of the DNS zone', type : 'uuid', length : 255, required : True, related : 'listDnsZones'}], response : [{}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'subdomain', description : 'The sub domain name of the auto-registered DNS record', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'dnszoneid', description : 'The ID of the DNS zone', type : 'string'}, {name : 'id', description : 'The ID of the mapping', type : 'string'}, {name : 'networkid', description : 'The ID of the Network', type : 'string'}], httprequesttype : 'POST'}, {name : 'scaleKubernetesCluster', description : 'Scales a created, running or stopped CloudManaged Kubernetes cluster', isasync : True, related : 'createKubernetesCluster,startKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean', length : 255, required : False}, {name : 'serviceofferingid', description : 'The ID of the service offering for the virtual machines in the cluster.', type : 'uuid', length : 255, required : False, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'minsize', description : 'Minimum number of worker nodes in the cluster', type : 'long', length : 255, required : False}, {name : 'nodeids', description : 'The IDs of the nodes to be removed', type : 'list', length : 255, required : False, related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'nodeofferings', description : '(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'maxsize', description : 'Maximum number of worker nodes in the cluster', type : 'long', length : 255, required : False}, {name : 'size', description : 'Number of Kubernetes cluster nodes', type : 'long', length : 255, required : False}], response : [{name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}], httprequesttype : 'POST'}, {name : 'destroyVolume', description : 'Destroys a Volume.', since : '4.14.0', isasync : True, related : 'createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume', params : [{name : 'expunge', description : 'If true is passed, the volume is expunged immediately. False by default.', type : 'boolean', length : 255, required : False, since : '4.6.0'}, {name : 'id', description : 'The ID of the volume', type : 'uuid', length : 255, required : True, related : 'createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}], response : [{name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}]}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'deviceid', description : 'The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.', type : 'long'}, {name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'vmstate', description : 'State of the Instance', type : 'string'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}], httprequesttype : 'POST'}, {name : 'stopSharedFileSystem', description : 'Stop a Shared FileSystem', since : '4.20.0', isasync : True, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering', params : [{name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}, {name : 'forced', description : 'Force stop the shared filesystem.', type : 'boolean', length : 255, required : False}], response : [{name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}]}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteRoutingFirewallRule', description : 'Deletes a routing firewall rule', since : '4.20.0', isasync : True, params : [{name : 'id', description : 'the ID of the Routing firewall rule', type : 'uuid', length : 255, required : True, related : 'createPortForwardingRule,updatePortForwardingRule'}], response : [{}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'changeServiceForSystemVm', description : 'Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect.', isasync : False, related : 'startSystemVm', params : [{name : 'details', description : 'Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value', type : 'map', length : 255, required : False}, {name : 'id', description : 'The ID of the System VM', type : 'uuid', length : 255, required : True, related : 'startSystemVm,changeServiceForSystemVm'}, {name : 'serviceofferingid', description : 'The service offering ID to apply to the System VM', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}], response : [{name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteVMSnapshot', description : 'Deletes an Instance Snapshot.', since : '4.2.0', isasync : True, params : [{name : 'vmsnapshotid', description : 'The ID of the Instance Snapshot', type : 'uuid', length : 255, required : True, related : 'listVMSnapshot,createVMSnapshot'}], response : [{}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listConsoleSessions', description : 'Lists console sessions.', since : '4.21.0', isasync : False, related : '', params : [{name : 'accountid', description : 'The ID of the account that created the console endpoint.', type : 'uuid', length : 255, required : False, related : 'disableAccount,enableAccount,updateAccount,listAccounts'}, {name : 'clientaddress', description : 'IP address of the client that accessed the console session.', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the console session.', type : 'uuid', length : 255, required : False, related : 'listConsoleSessions'}, {name : 'hostid', description : 'Lists console sessions from the specified host.', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,reconnectHost'}, {name : 'isrecursive', description : "Lists console sessions recursively per domain. If an account ID is informed, only the account's console sessions will be listed. Defaults to false.", type : 'boolean', length : 255, required : False}, {name : 'virtualmachineid', description : 'The ID of the virtual machine.', type : 'uuid', length : 255, required : False, related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'activeonly', description : 'Lists only active console sessions, defaults to true. Active sessions are the ones that have been acquired and have not been removed.', type : 'boolean', length : 255, required : False}, {name : 'startdate', description : 'Lists console sessions generated from this date onwards. The recommended format is "yyyy-MM-dd\'T\'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "00:00:00"). If the recommended format is not used, the date will be considered in the server timezone.', type : 'date', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'acquired', description : "Lists acquired console sessions, defaults to false. Acquired console sessions are the ones that have been accessed. The 'activeonly' parameter has precedence over the 'acquired' parameter, i.e., when the 'activeonly' parameter is 'true', the 'acquired' parameter value will be ignored.", type : 'boolean', length : 255, required : False}, {name : 'enddate', description : 'Lists console sessions generated up until this date. The recommended format is "yyyy-MM-dd\'T\'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "23:59:59"). If the recommended format is not used, the date will be considered in the server timezone.', type : 'date', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'consoleendpointcreatoraddress', description : 'IP address of the creator of the console endpoint.', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'The domain ID of the account that created the console endpoint.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'userid', description : 'The ID of the user that created the console endpoint.', type : 'uuid', length : 255, required : False, related : 'disableUser,getUser,listUsers,lockUser'}], response : [{}, {name : 'accountid', description : 'ID of the account that created the console endpoint.', type : 'string'}, {name : 'acquired', description : 'Date when the console session was acquired.', type : 'date'}, {name : 'clientaddress', description : 'IP address of the client that created the console session.', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'virtualmachinename', description : 'Name of the virtual machine.', type : 'string'}, {name : 'created', description : "Date when the console session's endpoint was created.", type : 'date'}, {name : 'domainpath', description : 'Domain path of the account that created the console endpoint.', type : 'string'}, {name : 'consoleendpointcreatoraddress', description : 'IP address of the creator of the console endpoint.', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the virtual machine.', type : 'string'}, {name : 'domain', description : 'Domain of the account that created the console endpoint.', type : 'string'}, {name : 'domainid', description : 'Domain ID of the account that created the console endpoint.', type : 'string'}, {name : 'user', description : 'User that created the console endpoint.', type : 'string'}, {name : 'hostname', description : 'Name of the host.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'ID of the console session.', type : 'string'}, {name : 'hostid', description : 'ID of the host.', type : 'string'}, {name : 'removed', description : 'Date when the console session was removed.', type : 'date'}, {}, {name : 'account', description : 'Account that created the console endpoint.', type : 'string'}, {name : 'userid', description : 'ID of the user that created the console endpoint.', type : 'string'}], httprequesttype : 'GET'}, {name : 'listCniConfiguration', description : 'List user data for CNI plugins', since : '4.21.0', isasync : False, related : '', params : [{name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'Userdata name to look for', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the Userdata', type : 'uuid', length : 255, required : False, related : 'listCniConfiguration'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}], response : [{}, {name : 'project', description : 'The project name of the User Data', type : 'string'}, {name : 'domainid', description : 'The domain id of the User Data owner', type : 'string'}, {name : 'userdata', description : 'Base64 encoded User Data content', type : 'string'}, {name : 'name', description : 'Name of the User Data', type : 'string'}, {name : 'id', description : 'ID of the User Data', type : 'string'}, {name : 'params', description : 'List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in the User Data', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'projectid', description : 'The project id of the User Data', type : 'string'}, {name : 'account', description : 'The owner of the User Data', type : 'string'}, {name : 'domain', description : 'The domain name of the User Data owner', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the User Data owner belongs', type : 'string'}, {}, {name : 'accountid', description : 'The owner id of the User Data', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}], httprequesttype : 'GET'}, {name : 'createSnapshotFromVMSnapshot', description : 'Creates an instant Snapshot of a volume from existing Instance Snapshot.', since : '4.10.0', isasync : True, related : 'copySnapshot,archiveSnapshot,listSnapshots', params : [{name : 'volumeid', description : 'The ID of the disk volume', type : 'uuid', length : 255, required : True, related : 'createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}, {name : 'vmsnapshotid', description : 'The ID of the Instance Snapshot', type : 'uuid', length : 255, required : True, related : 'listVMSnapshot,createVMSnapshot'}, {name : 'name', description : 'The name of the Snapshot', type : 'string', length : 255, required : False}], response : [{name : 'domain', description : "The domain name of the Snapshot's Account", type : 'string'}, {name : 'ostypeid', description : 'ID of the os on volume', type : 'string'}, {name : 'created', description : 'The date the Snapshot was created', type : 'date'}, {name : 'datastorestate', description : 'state of the snapshot on the datastore', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'snapshottype', description : 'The type of the Snapshot', type : 'string'}, {name : 'parentname', description : 'The parent name of the Snapshot', type : 'string'}, {name : 'project', description : 'The project name of the Snapshot', type : 'string'}, {name : 'revertable', description : 'Indicates whether the underlying storage supports reverting the volume to this Snapshot', type : 'boolean'}, {name : 'datastoretype', description : 'type of the datastore for the snapshot entry', type : 'string'}, {name : 'osdisplayname', description : 'Display name of the os on volume', type : 'string'}, {name : 'status', description : 'the status of the template', type : 'string'}, {name : 'datastorename', description : 'name of the datastore for the snapshot entry', type : 'string'}, {}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'projectid', description : 'The project id of the Snapshot', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'account', description : 'The Account associated with the Snapshot', type : 'string'}, {name : 'id', description : 'ID of the Snapshot', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'locationtype', description : 'Valid location types are primary and secondary.', type : 'string'}, {name : 'zonename', description : 'name of the availability zone', type : 'string'}, {name : 'volumetype', description : 'Type of the disk volume', type : 'string'}, {name : 'virtualsize', description : 'Virtual size of backedup Snapshot on image store', type : 'long'}, {name : 'datastoreid', description : 'ID of the datastore for the snapshot entry', type : 'string'}, {name : 'domainid', description : "The domain ID of the Snapshot's Account", type : 'string'}, {name : 'downloaddetails', description : 'download progress of a snapshot', type : 'map'}, {name : 'domainpath', description : "path of the Domain the snapshot's account belongs to", type : 'string'}, {name : 'volumeid', description : 'ID of the disk volume', type : 'string'}, {name : 'volumename', description : 'Name of the disk volume', type : 'string'}, {name : 'chainsize', description : 'chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true', type : 'long'}, {name : 'volumestate', description : 'state of the disk volume', type : 'string'}, {name : 'state', description : 'The state of the Snapshot. BackedUp means that Snapshot is ready to be used; Creating - the Snapshot is being allocated on the primary storage; BackingUp - the Snapshot is being backed up on secondary storage', type : 'state'}, {name : 'name', description : 'Name of the Snapshot', type : 'string'}, {name : 'parent', description : 'The parent ID of the Snapshot', type : 'string'}, {}, {name : 'physicalsize', description : 'Physical size of backed up Snapshot on image store', type : 'long'}, {name : 'intervaltype', description : 'Valid types are hourly, daily, weekly, monthy, Template, and none.', type : 'string'}], httprequesttype : 'POST'}, {name : 'listDnsServers', description : 'Lists DNS servers owned by the account.', since : '4.23.0', isasync : False, related : 'addDnsServer', params : [{name : 'providertype', description : 'filter by provider type (e.g. PowerDNS, Cloudflare)', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'id', description : 'the ID of the DNS server', type : 'uuid', length : 255, required : False, related : 'addDnsServer,listDnsServers'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}], response : [{name : 'provider', description : 'The provider type of the DNS server', type : 'string'}, {name : 'ispublic', description : 'Is the DNS server publicly available', type : 'boolean'}, {name : 'port', description : 'The port of the DNS server', type : 'integer'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'nameservers', description : 'Name servers entries associated to DNS server', type : 'list'}, {name : 'domain', description : 'the name of the domain associated with the DNS server', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'ID of the DNS server', type : 'string'}, {name : 'publicdomainsuffix', description : 'The public domain suffix for the DNS server', type : 'string'}, {name : 'state', description : 'The state of the account', type : 'string'}, {name : 'url', description : 'URL of the DNS server API', type : 'string'}, {name : 'account', description : 'the account associated with the DNS server', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the DNS server', type : 'string'}, {name : 'name', description : 'Name of the DNS server', type : 'string'}, {}, {}], httprequesttype : 'GET'}, {name : 'listBuckets', description : 'Lists all Buckets.', since : '4.19.0', isasync : False, related : '', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'objectstorageid', description : 'the ID of the object storage pool, available to ROOT admin only', type : 'uuid', length : 255, required : False, related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities'}, {name : 'name', description : 'the name of the bucket', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'id', description : 'the ID of the bucket', type : 'uuid', length : 255, required : False, related : 'listBuckets'}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'ids', description : 'the IDs of the Buckets, mutually exclusive with id', type : 'list', length : 255, required : False, related : 'listBuckets'}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'objectstorageid', description : 'id of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'account', description : 'the account associated with the Bucket', type : 'string'}, {name : 'objectstore', description : 'Name of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the bucket belongs', type : 'string'}, {name : 'provider', description : 'Object storage provider', type : 'string'}, {name : 'accesskey', description : 'Bucket Access Key', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the bucket', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'state', description : 'State of the Bucket', type : 'string'}, {name : 'objectlocking', description : 'Bucket Object Locking', type : 'boolean'}, {name : 'id', description : 'ID of the Bucket', type : 'string'}, {name : 'project', description : 'the project name of the bucket', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {}, {name : 'usersecretkey', description : 'Bucket Secret Key', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'policy', description : 'Bucket Access Policy', type : 'string'}, {name : 'name', description : 'name of the Bucket', type : 'string'}, {}, {name : 'domain', description : 'the domain associated with the bucket', type : 'string'}, {name : 'quota', description : 'Bucket Quota in GiB', type : 'integer'}, {name : 'encryption', description : 'Bucket Encryption', type : 'boolean'}, {name : 'projectid', description : 'the project id of the bucket', type : 'string'}, {name : 'url', description : 'Bucket URL', type : 'string'}, {name : 'created', description : 'the date the Bucket was created', type : 'date'}, {name : 'versioning', description : 'Bucket Versioning', type : 'boolean'}, {name : 'size', description : 'Total size of objects in Bucket', type : 'long'}], httprequesttype : 'GET'}, {name : 'stopInternalLoadBalancerVM', description : 'Stops an Internal LB Instance.', isasync : True, related : 'listRouters,changeServiceForRouter,listInternalLoadBalancerVMs', params : [{name : 'id', description : 'The ID of the internal LB Instance', type : 'uuid', length : 255, required : True, related : 'listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs'}, {name : 'forced', description : 'Force stop the Instance (Instance is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the Instance is stopped and should be marked as such.', type : 'boolean', length : 255, required : False}], response : [{name : 'ip6dns1', description : 'The first IPv6 DNS for the router', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the router', type : 'string'}, {}, {name : 'linklocalnetmask', description : 'The link local netmask for the router', type : 'string'}, {name : 'id', description : 'The ID of the router', type : 'string'}, {name : 'zonename', description : 'The Zone name for the router', type : 'string'}, {name : 'role', description : 'Role of the domain router', type : 'string'}, {name : 'domain', description : 'The domain associated with the router', type : 'string'}, {name : 'dns2', description : 'The second DNS for the router', type : 'string'}, {name : 'podname', description : 'The Pod name for the router', type : 'string'}, {name : 'ip6dns2', description : 'The second IPv6 DNS for the router', type : 'string'}, {name : 'templatename', description : 'The Template name for the router', type : 'string'}, {name : 'arch', description : 'CPU arch of the router', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the router', type : 'string'}, {name : 'templateid', description : 'The Template ID for the router', type : 'string'}, {name : 'healthcheckresults', description : 'Last executed health check result for the router', type : 'list', response : [{name : 'checkname', description : 'The name of the health check on the router', type : 'string'}, {name : 'lastupdated', description : 'The date this VPC was created', type : 'date'}, {name : 'details', description : 'Detailed response generated on running health check', type : 'string'}, {name : 'status', description : 'the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}', type : 'routerhealthstatus'}, {name : 'success', description : 'The result of the health check if available', type : 'boolean'}, {name : 'checktype', description : 'The type of the health check - basic or advanced', type : 'string'}]}, {name : 'hostcontrolstate', description : 'The control state of the host for the router', type : 'string'}, {name : 'domainid', description : 'The domain ID associated with the router', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the router', type : 'string'}, {name : 'hostname', description : 'The hostname for the router', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'publicip', description : 'The public IP address for the router', type : 'string'}, {name : 'guestnetmask', description : 'The guest netmask for the router', type : 'string'}, {name : 'scriptsversion', description : 'The version of scripts', type : 'string'}, {name : 'gateway', description : 'The gateway for the router', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'linklocalnetworkid', description : 'The ID of the corresponding link local Network', type : 'string'}, {name : 'isredundantrouter', description : 'If this router is an redundant virtual router', type : 'boolean'}, {name : 'state', description : 'The state of the router', type : 'state'}, {name : 'publicnetmask', description : 'The public netmask for the router', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the router', type : 'string'}, {name : 'guestipaddress', description : 'The guest IP address for the router', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'healthchecksfailed', description : 'True if any health checks had failed', type : 'boolean'}, {name : 'requiresupgrade', description : 'True if the router Template requires upgrade', type : 'boolean'}, {name : 'hostid', description : 'The host ID for the router', type : 'string'}, {name : 'name', description : 'The name of the router', type : 'string'}, {name : 'guestnetworkid', description : 'The ID of the corresponding guest Network', type : 'string'}, {name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {name : 'redundantstate', description : 'The state of redundant virtual router', type : 'string'}, {name : 'version', description : 'The version of Template', type : 'string'}, {name : 'vpcname', description : 'The name of VPC the router belongs to', type : 'string'}, {name : 'dns1', description : 'The first DNS for the router', type : 'string'}, {name : 'created', description : 'The date and time the router was created', type : 'date'}, {name : 'softwareversion', description : 'The version of the code / software in the router', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with the router', type : 'set', response : [{name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}]}, {name : 'podid', description : 'The Pod ID for the router', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'publicmacaddress', description : 'The public MAC address for the router', type : 'string'}, {}, {name : 'domainpath', description : 'path of the Domain the router belongs to', type : 'string'}, {name : 'vpcid', description : 'VPC the router belongs to', type : 'string'}, {name : 'publicnetworkid', description : 'The ID of the corresponding public Network', type : 'string'}, {name : 'guestmacaddress', description : 'The guest MAC address for the router', type : 'string'}, {name : 'guestnetworkname', description : 'The name of the corresponding guest Network', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'project', description : 'The project name of the address', type : 'string'}, {name : 'account', description : 'The Account associated with the router', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteUserData', description : 'Deletes a userdata', since : '4.18', isasync : False, params : [{name : 'projectid', description : 'An optional project for the userdata', type : 'uuid', length : 255, required : False, related : ''}, {name : 'id', description : 'The ID of the Userdata', type : 'uuid', length : 255, required : True, related : ''}, {name : 'domainid', description : 'An optional domainId for the userdata. If the account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'listDomains,listDomains'}, {name : 'account', description : 'An optional account for the userdata. Must be used with domainId.', type : 'string', length : 255, required : False}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}], httprequesttype : 'POST'}, {name : 'listVmsForImport', description : 'Lists virtual machines on a unmanaged host', since : '4.19.0', isasync : False, related : 'listVmwareDcVms,listUnmanagedInstances', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'password', description : 'the password for the host', type : 'string', length : 255, required : False}, {name : 'host', description : 'the host name or IP address', type : 'string', length : 255, required : True}, {name : 'username', description : 'the username for the host', type : 'string', length : 255, required : False}, {name : 'hypervisor', description : 'hypervisor type of the host', type : 'string', length : 255, required : True}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'memory', description : 'The memory of the Instance in MB', type : 'integer'}, {name : 'hypervisorversion', description : 'The hypervisor version of the host to which Instance belongs', type : 'string'}, {name : 'cpunumber', description : 'The CPU cores of the Instance', type : 'integer'}, {name : 'osid', description : 'The operating system ID of the Instance', type : 'string'}, {name : 'cpucorepersocket', description : 'The CPU cores per socket for the Instance. VMware specific', type : 'integer'}, {name : 'boottype', description : 'indicates the boot type', type : 'string'}, {name : 'hostname', description : 'The name of the host to which Instance belongs', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor to which Instance belongs', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'powerstate', description : 'The power state of the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'clusterid', description : 'The ID of the cluster to which Instance belongs', type : 'string'}, {name : 'disk', description : 'The list of disks associated with the Instance', type : 'set', response : [{name : 'id', description : 'The ID of the disk', type : 'string'}, {name : 'datastorehost', description : 'The controller of the disk', type : 'string'}, {name : 'capacity', description : 'The capacity of the disk in bytes', type : 'long'}, {name : 'imagepath', description : 'The file path of the disk image', type : 'string'}, {name : 'position', description : 'The position of the disk', type : 'integer'}, {name : 'label', description : 'The label of the disk', type : 'string'}, {name : 'datastorepath', description : 'The controller of the disk', type : 'string'}, {name : 'controllerunit', description : 'The controller unit of the disk', type : 'integer'}, {name : 'datastorename', description : 'The controller of the disk', type : 'string'}, {name : 'datastoretype', description : 'The controller of the disk', type : 'string'}, {name : 'controller', description : 'The controller of the disk', type : 'string'}]}, {}, {name : 'cpuspeed', description : 'The CPU speed of the Instance', type : 'integer'}, {name : 'bootmode', description : 'indicates the boot mode', type : 'string'}, {}, {name : 'nic', description : 'The list of NICs associated with the Instance', type : 'set', response : [{name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}]}, {name : 'hostid', description : 'The ID of the host to which Instance belongs', type : 'string'}, {name : 'clustername', description : 'the name of the cluster to which virtual machine belongs', type : 'string'}, {name : 'osdisplayname', description : 'The operating system of the Instance', type : 'string'}], httprequesttype : 'GET'}, {name : 'deleteUserFromProject', description : 'Deletes User from the project', since : '4.15.0', isasync : True, params : [{name : 'userid', description : 'Id of the User to be removed from the project', type : 'uuid', length : 255, required : True, related : 'disableUser,getUser,listUsers,lockUser'}, {name : 'projectid', description : 'ID of the project to remove the User from', type : 'uuid', length : 255, required : True, related : ''}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], httprequesttype : 'POST'}, {name : 'listProjectRoles', description : 'Lists Project roles in CloudStack', since : '4.15.0', isasync : False, related : 'updateProjectRole', params : [{name : 'name', description : 'List project role by project role name.', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'projectroleid', description : 'List project role by project role ID.', type : 'uuid', length : 255, required : False, related : 'listProjectRoles,updateProjectRole'}, {name : 'projectid', description : 'List project role by project ID.', type : 'uuid', length : 255, required : True, related : ''}], response : [{name : 'id', description : 'The ID of the role', type : 'string'}, {name : 'name', description : 'The name of the role', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'description', description : 'The description of the role', type : 'string'}, {name : 'ispublic', description : 'Indicates whether the role will be visible to all Users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).', type : 'boolean'}, {}, {name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'restoreBackup', description : 'Restores an existing stopped or deleted Instance using an Instance backup', since : '4.14.0', isasync : True, params : [{name : 'hostid', description : 'If quickrestore is true, which host to start the VM on; otherwise, ignored. Currently this parameter is only supported by the KBOSS provider.', type : 'uuid', length : 255, required : False, since : '4.23.0', related : 'declareHostAsDegraded,reconnectHost'}, {name : 'quickrestore', description : 'Whether to use the quick restore process or not. Currently this parameter is only supported by the KBOSS provider.', type : 'boolean', length : 255, required : False, since : '4.23.0', related : ''}, {name : 'id', description : 'ID of the backup', type : 'uuid', length : 255, required : True, related : ''}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listDnsZones', description : 'Lists DNS zones.', since : '4.23.0', isasync : False, related : '', params : [{name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'name', description : 'List by zone name', type : 'string', length : 255, required : False}, {name : 'dnsserverid', description : 'List DNS zones belonging to a specific DNS server', type : 'uuid', length : 255, required : False, related : 'addDnsServer'}, {name : 'id', description : 'List DNS zone by ID', type : 'uuid', length : 255, required : False, related : 'listDnsZones'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'networkname', description : 'Name of the network this zone is associated with', type : 'string'}, {name : 'account', description : 'the account associated with the DNS zone', type : 'string'}, {name : 'domain', description : 'the name of the domain associated with the DNS zone', type : 'string'}, {name : 'state', description : 'The state of the zone (Active/Inactive)', type : 'state'}, {name : 'id', description : 'ID of the DNS zone', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'dnsserverid', description : 'ID of the DNS server this zone belongs to', type : 'string'}, {name : 'type', description : 'The type of the zone (Public/Private)', type : 'zonetype'}, {name : 'description', description : 'Description for the DNS zone', type : 'string'}, {}, {}, {name : 'name', description : 'Name of the DNS zone', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the DNS server', type : 'string'}, {name : 'dnsservername', description : 'the name of the DNS server hosting this zone', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'networkid', description : 'ID of the network this zone is associated with', type : 'string'}, {name : 'dnsserveraccount', description : 'the account name of the DNS server owner', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateVmNic', description : 'Updates the specified VM NIC', isasync : True, related : '', params : [{name : 'enabled', description : 'If true, sets the NIC state to UP; otherwise, sets the NIC state to DOWN', type : 'boolean', length : 255, required : False}, {name : 'nicid', description : 'NIC ID', type : 'uuid', length : 255, required : True, related : 'updateVmNic'}], response : [{name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}], httprequesttype : 'POST'}, {name : 'registerCniConfiguration', description : 'Register a CNI Configuration to be used with CKS cluster', since : '4.21.0', isasync : False, params : [{name : 'name', description : 'Name of the user data', type : 'string', length : 255, required : True}, {name : 'domainid', description : 'an optional domainId for the user data. If the account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'cniconfig', description : 'CNI Configuration content to be registered as User data', type : 'string', length : 1048576, required : False}, {name : 'account', description : 'an optional account for the user data. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'params', description : 'comma separated list of variables declared in user data content', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'an optional project for the user data', type : 'uuid', length : 255, required : False, related : ''}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'linkUserDataToTemplate', description : 'Link or unlink a userdata to a Template.', since : '4.18.0', isasync : False, related : 'listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate', params : [{name : 'isoid', description : 'The ID of the ISO for the Instance', type : 'uuid', length : 255, required : False, related : 'listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'userdataid', description : 'The ID of the userdata that has to be linked to Template/ISO. If not provided existing userdata will be unlinked from the Template/ISO', type : 'uuid', length : 255, required : False, related : ''}, {name : 'templateid', description : 'The ID of the Template for the Instance', type : 'uuid', length : 255, required : False, related : 'listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'userdatapolicy', description : 'An optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride', type : 'string', length : 255, required : False}], response : [{name : 'userdataid', description : 'The id of userdata linked to this Template', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'hostname', description : 'The name of the secondary storage host for the Template', type : 'string'}, {name : 'directdownload', description : 'KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage', type : 'boolean'}, {name : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {name : 'id', description : 'The Template ID', type : 'string'}, {name : 'parenttemplateid', description : 'If Datadisk Template, then id of the root disk Template this Template belongs to', type : 'string'}, {name : 'userdataparams', description : 'List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata', type : 'string'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'bits', description : 'The processor bit size', type : 'int'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'project', description : 'The project name of the Template', type : 'string'}, {name : 'url', description : 'The URL which the Template/ISO is registered from', type : 'string'}, {name : 'arch', description : 'CPU Arch of the template', type : 'string'}, {name : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'userdataname', description : 'The name of userdata linked to this Template', type : 'string'}, {}, {name : 'templatetype', description : 'The type of the Template', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {name : 'status', description : 'The status of the Template', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'deployasis', description : 'VMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.', type : 'boolean'}, {name : 'extensionname', description : 'The name of extension linked to this template', type : 'string'}, {name : 'name', description : 'The Template name', type : 'string'}, {name : 'domain', description : 'The name of the domain to which the Template belongs', type : 'string'}, {name : 'zonename', description : 'The name of the zone for this Template', type : 'string'}, {name : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {name : 'domainid', description : 'The ID of the domain to which the Template belongs', type : 'string'}, {name : 'ostypeid', description : 'The ID of the OS type for this Template.', type : 'string'}, {name : 'checksum', description : 'Checksum of the Template', type : 'string'}, {name : 'extensionid', description : 'The ID of extension linked to this template', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'accountid', description : 'The Account id to which the Template belongs', type : 'string'}, {name : 'templatetag', description : 'The tag of this Template', type : 'string'}, {}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'sshkeyenabled', description : 'True if Template is sshkey enabled, false otherwise', type : 'boolean'}, {name : 'requireshvm', description : 'True if Template requires HVM enabled, false otherwise', type : 'boolean'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'passwordenabled', description : 'True if the reset password feature is enabled, false otherwise', type : 'boolean'}, {name : 'removed', description : 'The date this Template was removed', type : 'date'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {name : 'isextractable', description : 'True if the Template is extractable, false otherwise', type : 'boolean'}, {name : 'isready', description : 'True if the Template is ready to be deployed from, false otherwise.', type : 'boolean'}, {}, {name : 'format', description : 'The format of the Template.', type : 'imageformat'}, {name : 'ispublic', description : 'True if this Template is a public Template, false otherwise', type : 'boolean'}, {name : 'displaytext', description : 'The Template display text', type : 'string'}, {name : 'hostid', description : 'The ID of the secondary storage host for the Template', type : 'string'}, {name : 'crossZones', description : 'True if the Template is managed across all Zones, false otherwise', type : 'boolean'}, {name : 'account', description : 'The Account name to which the Template belongs', type : 'string'}, {name : 'size', description : 'The size of the Template', type : 'long'}, {name : 'sourcetemplateid', description : 'The Template ID of the parent Template if present', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}], httprequesttype : 'POST'}, {name : 'listCustomActions', description : 'Lists the custom actions', since : '4.21.0', isasync : False, related : '', params : [{name : 'extensionid', description : 'uuid of the extension', type : 'uuid', length : 255, required : False, related : 'listExtensions,updateExtension'}, {name : 'enabled', description : 'List actions whether they are enabled or not', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'Name of the custom action', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'resourcetype', description : 'Type of the resource for actions', type : 'string', length : 255, required : False}, {name : 'id', description : 'uuid of the custom action', type : 'uuid', length : 255, required : False, related : 'listCustomActions'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'resourceid', description : 'ID of a resource for actions', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'timeout', description : 'Specifies the timeout in seconds to wait for the action to complete before failing', type : 'integer'}, {name : 'enabled', description : 'Whether the custom action is enabled or not', type : 'boolean'}, {}, {name : 'description', description : 'Description of the custom action', type : 'string'}, {name : 'resourcetype', description : 'Resource type for which the action is available', type : 'string'}, {name : 'details', description : 'Details of the custom action', type : 'map'}, {name : 'successmessage', description : 'Message that will be used on successful execution of the action', type : 'string'}, {name : 'parameters', description : 'List of the parameters for the action', type : 'list', response : [{name : 'required', description : 'Whether the parameter is required or not', type : 'boolean'}, {name : 'valueoptions', description : 'Comma-separated list of options for value of the parameter', type : 'list'}, {name : 'validationformat', description : 'Validation format for value of the parameter. Available for specific types', type : 'string'}, {name : 'type', description : 'Type of the parameter', type : 'string'}, {name : 'name', description : 'Name of the parameter', type : 'string'}]}, {name : 'allowedroletypes', description : 'List of role types allowed for the custom action', type : 'list'}, {}, {name : 'created', description : 'Creation timestamp of the custom action', type : 'date'}, {name : 'name', description : 'Name of the custom action', type : 'string'}, {name : 'extensionname', description : 'Name of the extension that this custom action belongs to', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'ID of the custom action', type : 'string'}, {name : 'extensionid', description : 'ID of the extension that this custom action belongs to', type : 'string'}, {name : 'errormessage', description : 'Message that will be used on failure during execution of the action', type : 'string'}], httprequesttype : 'GET'}, {name : 'getKubernetesClusterConfig', description : 'Get Kubernetes cluster config', isasync : False, related : '', params : [{name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : False, related : 'createKubernetesCluster,startKubernetesCluster,updateKubernetesClusterAffinityGroups'}], response : [{name : 'id', description : 'The ID of the container cluster', type : 'string'}, {}, {name : 'configdata', description : 'The config data of the cluster', type : 'string'}, {name : 'name', description : 'Name of the container cluster', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], httprequesttype : 'GET'}, {name : 'disassociateDnsZoneFromNetwork', description : 'Removes the association between a DNS Zone and a Network', since : '4.23.0', isasync : False, params : [{name : 'networkid', description : 'The ID of the Network', type : 'uuid', length : 255, required : True, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork'}], response : [{}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listInternalLoadBalancerVMs', description : 'List internal LB Instances.', isasync : False, related : 'listRouters', params : [{name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'vpcid', description : 'List Internal LB Instances by VPC', type : 'uuid', length : 255, required : False, related : 'listVPCs,createVPC,listVPCs,updateVPC'}, {name : 'id', description : 'The ID of the Internal LB Instance', type : 'uuid', length : 255, required : False, related : 'deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'podid', description : 'The Pod ID of the Internal LB Instance', type : 'uuid', length : 255, required : False, related : 'createManagementNetworkIpRange'}, {name : 'forvpc', description : 'If true is passed for this parameter, list only VPC Internal LB Instances', type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'hostid', description : 'The host ID of the Internal LB Instance', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,reconnectHost'}, {name : 'zoneid', description : 'The Zone ID of the Internal LB Instance', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'state', description : 'The state of the Internal LB Instance', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'name', description : 'The name of the Internal LB Instance', type : 'string', length : 255, required : False}, {name : 'fetchhealthcheckresults', description : 'If true is passed for this parameter, also fetch last executed health check results for the Instance. Default is false', type : 'boolean', length : 255, required : False, since : '4.14'}], response : [{name : 'hostname', description : 'The hostname for the router', type : 'string'}, {name : 'created', description : 'The date and time the router was created', type : 'date'}, {name : 'zoneid', description : 'The Zone ID for the router', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'podname', description : 'The Pod name for the router', type : 'string'}, {name : 'vpcname', description : 'The name of VPC the router belongs to', type : 'string'}, {name : 'role', description : 'Role of the domain router', type : 'string'}, {name : 'vpcid', description : 'VPC the router belongs to', type : 'string'}, {name : 'version', description : 'The version of Template', type : 'string'}, {name : 'templatename', description : 'The Template name for the router', type : 'string'}, {name : 'publicnetworkid', description : 'The ID of the corresponding public Network', type : 'string'}, {name : 'guestipaddress', description : 'The guest IP address for the router', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with the router', type : 'set', response : [{name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}]}, {name : 'scriptsversion', description : 'The version of scripts', type : 'string'}, {name : 'arch', description : 'CPU arch of the router', type : 'string'}, {name : 'ip6dns1', description : 'The first IPv6 DNS for the router', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the router belongs to', type : 'string'}, {}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {name : 'domain', description : 'The domain associated with the router', type : 'string'}, {name : 'publicip', description : 'The public IP address for the router', type : 'string'}, {name : 'healthcheckresults', description : 'Last executed health check result for the router', type : 'list', response : [{name : 'lastupdated', description : 'The date this VPC was created', type : 'date'}, {name : 'details', description : 'Detailed response generated on running health check', type : 'string'}, {name : 'success', description : 'The result of the health check if available', type : 'boolean'}, {name : 'status', description : 'the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}', type : 'routerhealthstatus'}, {name : 'checktype', description : 'The type of the health check - basic or advanced', type : 'string'}, {name : 'checkname', description : 'The name of the health check on the router', type : 'string'}]}, {name : 'publicnetmask', description : 'The public netmask for the router', type : 'string'}, {name : 'redundantstate', description : 'The state of redundant virtual router', type : 'string'}, {name : 'hostid', description : 'The host ID for the router', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the router', type : 'string'}, {name : 'ip6dns2', description : 'The second IPv6 DNS for the router', type : 'string'}, {name : 'dns1', description : 'The first DNS for the router', type : 'string'}, {name : 'gateway', description : 'The gateway for the router', type : 'string'}, {name : 'guestmacaddress', description : 'The guest MAC address for the router', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'linklocalnetmask', description : 'The link local netmask for the router', type : 'string'}, {name : 'zonename', description : 'The Zone name for the router', type : 'string'}, {name : 'healthchecksfailed', description : 'True if any health checks had failed', type : 'boolean'}, {name : 'guestnetworkid', description : 'The ID of the corresponding guest Network', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the router', type : 'string'}, {name : 'isredundantrouter', description : 'If this router is an redundant virtual router', type : 'boolean'}, {name : 'linklocalnetworkid', description : 'The ID of the corresponding link local Network', type : 'string'}, {name : 'templateid', description : 'The Template ID for the router', type : 'string'}, {}, {name : 'networkdomain', description : 'The Network domain for the router', type : 'string'}, {name : 'guestnetmask', description : 'The guest netmask for the router', type : 'string'}, {name : 'softwareversion', description : 'The version of the code / software in the router', type : 'string'}, {name : 'id', description : 'The ID of the router', type : 'string'}, {name : 'dns2', description : 'The second DNS for the router', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the router', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'guestnetworkname', description : 'The name of the corresponding guest Network', type : 'string'}, {name : 'requiresupgrade', description : 'True if the router Template requires upgrade', type : 'boolean'}, {name : 'state', description : 'The state of the router', type : 'state'}, {name : 'podid', description : 'The Pod ID for the router', type : 'string'}, {name : 'domainid', description : 'The domain ID associated with the router', type : 'string'}, {name : 'project', description : 'The project name of the address', type : 'string'}, {name : 'name', description : 'The name of the router', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the router', type : 'string'}, {name : 'account', description : 'The Account associated with the router', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}], httprequesttype : 'GET'}, {name : 'uploadResourceIcon', description : 'Uploads an icon for the specified resource(s)', since : '4.16.0.0', isasync : False, params : [{name : 'base64image', description : 'Base64 string representation of the resource icon/image', type : 'string', length : 2097152, required : True}, {name : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : True}, {name : 'resourceids', description : 'List of resources to upload the icon/image for', type : 'list', length : 255, required : True}], response : [{}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listHSMProfiles', description : 'Lists HSM profiles', since : '4.23.0', isasync : False, related : '', params : [{name : 'enabled', description : 'list only enabled profiles', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'the HSM profile ID', type : 'uuid', length : 255, required : False, related : 'listHSMProfiles'}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'ispublic', description : 'when true, non-admin users see only system (global) profiles', type : 'boolean', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'protocol', description : 'the protocol of the HSM profile', type : 'string', length : 255, required : False}], response : [{name : 'domainid', description : 'the domain ID of the HSM profile owner', type : 'string'}, {name : 'id', description : 'the ID of the HSM profile', type : 'string'}, {name : 'accountid', description : 'the account ID of the HSM profile owner', type : 'string'}, {name : 'projectid', description : 'the project ID of the HSM profile owner', type : 'string'}, {}, {name : 'zonename', description : 'the zone name where the HSM profile is available', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'state', description : 'the state of the HSM profile', type : 'string'}, {name : 'project', description : 'the project name of the HSM profile owner', type : 'string'}, {name : 'domain', description : 'the domain name of the HSM profile owner', type : 'string'}, {}, {name : 'enabled', description : 'whether the HSM profile is enabled', type : 'boolean'}, {name : 'created', description : 'the date the HSM profile was created', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'protocol', description : 'the protocol of the HSM profile', type : 'string'}, {name : 'details', description : 'HSM configuration details (sensitive values are encrypted)', type : 'map'}, {name : 'ispublic', description : 'whether this is a system HSM profile available to all users globally', type : 'boolean'}, {name : 'account', description : 'the account name of the HSM profile owner', type : 'string'}, {name : 'domainpath', description : 'the domain path of the HSM profile owner', type : 'string'}, {name : 'name', description : 'the name of the HSM profile', type : 'string'}, {name : 'zoneid', description : 'the zone ID where the HSM profile is available', type : 'string'}, {name : 'vendor', description : 'the vendor name of the HSM profile', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateAutoScaleVmProfile', description : 'Updates an existing autoscale Instance profile.', isasync : True, related : 'listAutoScaleVmProfiles', params : [{name : 'serviceofferingid', description : 'The service offering of the auto deployed  Instance', type : 'uuid', length : 255, required : False, since : '4.18.0', related : 'updateServiceOffering,listServiceOfferings'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer', length : 255, required : False}, {name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId of the auto deployed  Instance. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids\'" and "networkids".', type : 'map', length : 255, required : False, since : '4.18.0'}, {name : 'autoscaleuserid', description : 'The ID of the user used to launch and destroy the Instances', type : 'uuid', length : 255, required : False, related : 'disableUser,getUser,listUsers,lockUser'}, {name : 'userdatadetails', description : 'used to specify the parameters values for the variables in userdata.', type : 'map', length : 255, required : False, since : '4.18.1'}, {name : 'fordisplay', description : 'An optional field, whether to the display the profile to the end user or not', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'userdataid', description : 'the ID of the userdata', type : 'uuid', length : 255, required : False, since : '4.18.1', related : ''}, {name : 'counterparam', description : 'counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161', type : 'map', length : 255, required : False}, {name : 'templateid', description : 'The Template of the auto deployed Instance', type : 'uuid', length : 255, required : False, related : 'listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'id', description : 'The ID of the autoscale Instance profile', type : 'uuid', length : 255, required : True, related : 'listAutoScaleVmProfiles,updateAutoScaleVmProfile'}, {name : 'customid', description : 'An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only', type : 'string', length : 255, required : False, since : '4.4'}, {name : 'userdata', description : 'An optional binary data that can be sent to the  Instance upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value', type : 'string', length : 1048576, required : False, since : '4.18.0'}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'projectid', description : 'The project id Instance profile', type : 'string'}, {name : 'userdatadetails', description : 'list of variables and values for the variables declared in userdata', type : 'string'}, {name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance', type : 'map'}, {name : 'templateid', description : 'The Template to be used while deploying an Instance', type : 'string'}, {}, {name : 'domainid', description : 'The domain ID of the Instance profile', type : 'string'}, {name : 'userdata', description : 'Base64 encoded Instance user data', type : 'string'}, {name : 'autoscaleuserid', description : 'The ID of the User used to launch and destroy the Instances', type : 'string'}, {}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'serviceofferingid', description : 'The service offering to be used while deploying an Instance', type : 'string'}, {name : 'userdatapolicy', description : 'the userdata override policy with the userdata provided while deploying VM', type : 'string'}, {name : 'id', description : 'The autoscale Instance profile ID', type : 'string'}, {name : 'userdataid', description : 'the id of userdata used for the VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainpath', description : 'path of the domain to which the vm profile belongs', type : 'string'}, {name : 'userdataname', description : 'the name of userdata used for the VM', type : 'string'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer'}, {}, {name : 'domain', description : 'The domain name of the Instance profile', type : 'string'}, {name : 'project', description : 'The project name of the Instance profile', type : 'string'}, {name : 'fordisplay', description : 'Is profile for display to the regular User', type : 'boolean'}, {}, {name : 'zoneid', description : 'The availability zone to be used while deploying an Instance', type : 'string'}], httprequesttype : 'POST'}, {name : 'enableAutoScaleVmGroup', description : 'Enables an AutoScale Instance Group', isasync : True, related : '', params : [{name : 'id', description : 'The ID of the autoscale group', type : 'uuid', length : 255, required : True, related : 'enableAutoScaleVmGroup'}], response : [{name : 'lbprovider', description : 'The LB provider of the guest Network the LB rule belongs to', type : 'string'}, {name : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {}, {name : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {name : 'publicport', description : 'The public port', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}, {name : 'publicip', description : 'The public IP address', type : 'string'}, {name : 'projectid', description : 'The project id of the Instance group', type : 'string'}, {name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {name : 'associatednetworkname', description : 'The name of the guest Network the LB rule belongs to', type : 'string'}, {name : 'maxmembers', description : 'The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.', type : 'int'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {name : 'privateport', description : 'The private port', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {}, {name : 'created', description : 'The date when this Instance group was created', type : 'date'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'minmembers', description : 'The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.', type : 'int'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'project', description : 'The project name of the Instance group', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'state', description : 'The current state of the AutoScale Instance Group', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'publicipid', description : 'The public IP address ID', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the vm group belongs', type : 'string'}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'deleteWebhookDelivery', description : 'Deletes Webhook delivery', since : '4.20.0', isasync : False, params : [{name : 'startdate', description : 'The start date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having start date equal to or after the specified date will be considered.', type : 'date', length : 255, required : False}, {name : 'managementserverid', description : 'The ID of the management server', type : 'uuid', length : 255, required : False, related : ''}, {name : 'enddate', description : 'The end date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having end date equal to or before the specified date will be considered.', type : 'date', length : 255, required : False}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,updateWebhook'}, {name : 'id', description : 'The ID of the Webhook delivery', type : 'uuid', length : 255, required : False, related : ''}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'listVmwareDcVms', description : 'Lists the VMs in a VMware Datacenter', isasync : False, related : 'listUnmanagedInstances', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'datacentername', description : 'Name of VMware datacenter.', type : 'string', length : 255, required : False}, {name : 'hostname', description : 'Name of the host on vCenter. Must be set along with the instancename parameter', type : 'string', length : 255, required : False}, {name : 'username', description : 'The Username required to connect to resource.', type : 'string', length : 255, required : False}, {name : 'vcenter', description : 'The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'instancename', description : 'Name of the VM on vCenter. Must be set along with the hostname parameter', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'password', description : 'The password for specified username.', type : 'string', length : 255, required : False}, {name : 'existingvcenterid', description : 'UUID of a linked existing vCenter', type : 'uuid', length : 255, required : False, related : ''}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'cpucorepersocket', description : 'The CPU cores per socket for the Instance. VMware specific', type : 'integer'}, {name : 'osid', description : 'The operating system ID of the Instance', type : 'string'}, {name : 'bootmode', description : 'indicates the boot mode', type : 'string'}, {name : 'hostname', description : 'The name of the host to which Instance belongs', type : 'string'}, {name : 'powerstate', description : 'The power state of the Instance', type : 'string'}, {name : 'clustername', description : 'the name of the cluster to which virtual machine belongs', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor to which Instance belongs', type : 'string'}, {name : 'osdisplayname', description : 'The operating system of the Instance', type : 'string'}, {name : 'hostid', description : 'The ID of the host to which Instance belongs', type : 'string'}, {name : 'cpunumber', description : 'The CPU cores of the Instance', type : 'integer'}, {name : 'cpuspeed', description : 'The CPU speed of the Instance', type : 'integer'}, {}, {name : 'memory', description : 'The memory of the Instance in MB', type : 'integer'}, {name : 'hypervisorversion', description : 'The hypervisor version of the host to which Instance belongs', type : 'string'}, {name : 'disk', description : 'The list of disks associated with the Instance', type : 'set', response : [{name : 'controller', description : 'The controller of the disk', type : 'string'}, {name : 'controllerunit', description : 'The controller unit of the disk', type : 'integer'}, {name : 'capacity', description : 'The capacity of the disk in bytes', type : 'long'}, {name : 'imagepath', description : 'The file path of the disk image', type : 'string'}, {name : 'datastorename', description : 'The controller of the disk', type : 'string'}, {name : 'id', description : 'The ID of the disk', type : 'string'}, {name : 'label', description : 'The label of the disk', type : 'string'}, {name : 'datastorepath', description : 'The controller of the disk', type : 'string'}, {name : 'position', description : 'The position of the disk', type : 'integer'}, {name : 'datastoretype', description : 'The controller of the disk', type : 'string'}, {name : 'datastorehost', description : 'The controller of the disk', type : 'string'}]}, {name : 'boottype', description : 'indicates the boot type', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with the Instance', type : 'set', response : [{name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}]}, {name : 'clusterid', description : 'The ID of the cluster to which Instance belongs', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'getUserKeys', description : 'Queries the last registered secret and API keys of a user.', since : '4.10.0', isasync : False, related : '', params : [{name : 'id', description : 'ID of the user whose keys are required', type : 'uuid', length : 255, required : True, related : 'disableUser,getUser,listUsers,lockUser'}], response : [{name : 'secretkey', description : 'The secret key of the registered user', type : 'string'}, {}, {}, {name : 'apikeyaccess', description : 'Whether API key access is allowed or not', type : 'boolean'}, {name : 'apikey', description : 'The API key of the registered user', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'rotateKMSKey', description : 'Rotates KMS key (KEK) by creating new version and scheduling gradual re-encryption', since : '4.23.0', isasync : True, related : 'queryAsyncJobResult', params : [{name : 'hsmprofileid', description : 'The target HSM profile ID for the new KEK version. If provided, migrates the key to this HSM.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'keybits', description : 'Key size for new KEK (default: same as current)', type : 'integer', length : 255, required : False}, {name : 'id', description : 'KMS Key UUID to rotate', type : 'uuid', length : 255, required : True, related : 'createKMSKey,updateKMSKey'}], response : [{name : 'jobresultcode', description : 'The result code for the job', type : 'integer'}, {name : 'created', description : 'The created date of the job', type : 'date'}, {name : 'domainid', description : 'The domain ID that executed the async command', type : 'string'}, {}, {name : 'completed', description : 'The completed date of the job', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'accountid', description : 'The Account ID that executed the async command', type : 'string'}, {name : 'jobresult', description : 'The result reason', type : 'responseobject'}, {name : 'jobinstanceid', description : 'The unique ID of the Instance/entity object related to the job', type : 'string'}, {}, {name : 'jobprocstatus', description : 'The progress information of the PENDING job', type : 'integer'}, {name : 'domainpath', description : 'The domain that executed the async command', type : 'string'}, {name : 'managementserverid', description : 'The MSID of the management server on which the job is running', type : 'string'}, {name : 'userid', description : 'The User that executed the async command', type : 'string'}, {name : 'cmd', description : 'The async command executed', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobinstancetype', description : 'The Instance/entity object related to the job', type : 'string'}, {name : 'managementservername', description : 'the management server name of the host', type : 'string'}, {name : 'account', description : 'The Account that executed the async command', type : 'string'}, {name : 'jobresulttype', description : 'The result type', type : 'string'}], httprequesttype : 'POST'}, {name : 'changeSharedFileSystemServiceOffering', description : 'Change Service offering of a Shared FileSystem', since : '4.20.0', isasync : True, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering', params : [{name : 'serviceofferingid', description : 'the offering to use for the shared filesystem instance', type : 'uuid', length : 255, required : True, related : 'updateServiceOffering,listServiceOfferings'}, {name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}], response : [{name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}]}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}], httprequesttype : 'POST'}, {name : 'cloudianIsEnabled', description : 'Checks if the Cloudian Connector is enabled', since : '4.11.0', isasync : False, related : '', params : [], response : [{name : 'enabled', description : 'The Cloudian connector enabled state', type : 'boolean'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'url', description : 'The Cloudian Management Console base URL', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], httprequesttype : 'GET'}, {name : 'copySnapshot', description : 'Copies a snapshot from one zone to another.', since : '4.19.0', isasync : True, related : 'listSnapshots', params : [{name : 'sourcezoneid', description : "The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used.", type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'storageids', description : 'A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present. Currently supported for StorPool only', type : 'list', length : 255, required : False, since : '4.21.0', related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool'}, {name : 'id', description : 'the ID of the snapshot.', type : 'uuid', length : 255, required : True, related : 'copySnapshot,listSnapshots'}, {name : 'destzoneid', description : 'The ID of the zone the snapshot is being copied to.', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'destzoneids', description : 'A comma-separated list of IDs of the zones that the snapshot needs to be copied to. Specify this list if the snapshot needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.', type : 'list', length : 255, required : False, related : 'listZones'}, {name : 'usestoragereplication', description : "Enables the snapshot to be copied to the supported primary storages when the config 'use.storage.replication' is set to true for the storage or globally. This is supported only for StorPool storage for now.", type : 'boolean', length : 255, required : False, since : '4.21.0'}], response : [{name : 'status', description : 'the status of the template', type : 'string'}, {name : 'snapshottype', description : 'The type of the Snapshot', type : 'string'}, {name : 'virtualsize', description : 'Virtual size of backedup Snapshot on image store', type : 'long'}, {name : 'locationtype', description : 'Valid location types are primary and secondary.', type : 'string'}, {name : 'datastoreid', description : 'ID of the datastore for the snapshot entry', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'volumename', description : 'Name of the disk volume', type : 'string'}, {name : 'ostypeid', description : 'ID of the os on volume', type : 'string'}, {name : 'account', description : 'The Account associated with the Snapshot', type : 'string'}, {name : 'downloaddetails', description : 'download progress of a snapshot', type : 'map'}, {name : 'datastorename', description : 'name of the datastore for the snapshot entry', type : 'string'}, {name : 'domainpath', description : "path of the Domain the snapshot's account belongs to", type : 'string'}, {name : 'created', description : 'The date the Snapshot was created', type : 'date'}, {name : 'parent', description : 'The parent ID of the Snapshot', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'Name of the Snapshot', type : 'string'}, {name : 'parentname', description : 'The parent name of the Snapshot', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}]}, {name : 'state', description : 'The state of the Snapshot. BackedUp means that Snapshot is ready to be used; Creating - the Snapshot is being allocated on the primary storage; BackingUp - the Snapshot is being backed up on secondary storage', type : 'state'}, {name : 'domain', description : "The domain name of the Snapshot's Account", type : 'string'}, {name : 'intervaltype', description : 'Valid types are hourly, daily, weekly, monthy, Template, and none.', type : 'string'}, {name : 'zonename', description : 'name of the availability zone', type : 'string'}, {}, {name : 'id', description : 'ID of the Snapshot', type : 'string'}, {}, {name : 'datastorestate', description : 'state of the snapshot on the datastore', type : 'string'}, {name : 'project', description : 'The project name of the Snapshot', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'domainid', description : "The domain ID of the Snapshot's Account", type : 'string'}, {name : 'chainsize', description : 'chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true', type : 'long'}, {name : 'volumeid', description : 'ID of the disk volume', type : 'string'}, {name : 'projectid', description : 'The project id of the Snapshot', type : 'string'}, {name : 'physicalsize', description : 'Physical size of backed up Snapshot on image store', type : 'long'}, {name : 'volumestate', description : 'state of the disk volume', type : 'string'}, {name : 'revertable', description : 'Indicates whether the underlying storage supports reverting the volume to this Snapshot', type : 'boolean'}, {name : 'osdisplayname', description : 'Display name of the os on volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'datastoretype', description : 'type of the datastore for the snapshot entry', type : 'string'}, {name : 'volumetype', description : 'Type of the disk volume', type : 'string'}], httprequesttype : 'POST'}, {name : 'createDnsRecord', description : 'Creates a DNS record directly on the provider', since : '4.23.0', isasync : True, related : '', params : [{name : 'type', description : 'DNS record type (e.g., A, AAAA, CNAME, MX, TXT, etc.)', type : 'string', length : 255, required : True}, {name : 'name', description : 'DNS record name', type : 'string', length : 255, required : True}, {name : 'ttl', description : 'Time to live', type : 'integer', length : 255, required : False}, {name : 'dnszoneid', description : 'ID of the DNS zone', type : 'uuid', length : 255, required : True, related : ''}, {name : 'contents', description : 'The content of the record (IP address for A/AAAA, FQDN for CNAME/NS, quoted string for TXT, etc.)', type : 'list', length : 255, required : True}], response : [{name : 'contents', description : 'The contents of the record (IP address or target)', type : 'list'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'name', description : 'The record name (e.g., www.example.com.)', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'ttl', description : 'Time to live (TTL) in seconds', type : 'integer'}, {}, {name : 'type', description : 'The record type (e.g., A, CNAME, TXT)', type : 'recordtype'}], httprequesttype : 'POST'}, {name : 'listSharedFileSystems', description : 'List Shared FileSystems', since : '4.20.0', isasync : False, related : 'changeSharedFileSystemDiskOffering', params : [{name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : False, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering'}, {name : 'zoneid', description : 'the ID of the availability zone', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", type : 'boolean', length : 255, required : False}, {name : 'networkid', description : 'the ID of the network', type : 'uuid', length : 255, required : False, related : 'createNetwork,updateNetwork,listNetworks,migrateNetwork'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'diskofferingid', description : 'the disk offering of the shared filesystem', type : 'uuid', length : 255, required : False, related : ''}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'the name of the shared filesystem', type : 'string', length : 255, required : False}, {name : 'serviceofferingid', description : 'the service offering of the shared filesystem', type : 'uuid', length : 255, required : False, related : 'updateServiceOffering,listServiceOfferings'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}], response : [{name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}]}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}], httprequesttype : 'GET'}, {name : 'deleteWebhook', description : 'Deletes a Webhook', since : '4.20.0', isasync : False, params : [{name : 'id', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : True, related : 'createWebhook,updateWebhook'}], response : [{}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'startSystemVm', description : 'Starts a System VM.', isasync : True, related : '', params : [{name : 'id', description : 'The ID of the System VM', type : 'uuid', length : 255, required : True, related : 'startSystemVm'}], response : [{name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'registerVnfTemplate', description : 'Registers an existing VNF template into the CloudStack cloud. ', since : '4.19.0', isasync : False, related : 'registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate', params : [{name : 'bits', description : '32 or 64 bits support. 64 by default', type : 'integer', length : 255, required : False}, {name : 'vnfnics', description : 'VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue.  Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC', type : 'map', length : 255, required : False}, {name : 'name', description : 'The name of the Template', type : 'string', length : 255, required : True}, {name : 'displaytext', description : "The display text of the Template, defaults to 'name'.", type : 'string', length : 4096, required : False}, {name : 'requireshvm', description : 'True if this Template requires HVM', type : 'boolean', length : 255, required : False}, {name : 'ostypeid', description : 'The ID of the OS Type that best represents the OS of this Template. Not applicable with VMware, as we honour what is defined in the Template', type : 'uuid', length : 255, required : False, related : ''}, {name : 'vnfdetails', description : 'VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0', type : 'map', length : 255, required : False}, {name : 'deployasis', description : '(VMware only) true if Instance deployments should preserve all the configurations defined for this Template', type : 'boolean', length : 255, required : False, since : '4.15.1'}, {name : 'passwordenabled', description : 'True if the Template supports the password reset feature; default is false', type : 'boolean', length : 255, required : False}, {name : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance cpu/memory', type : 'boolean', length : 255, required : False}, {name : 'url', description : 'The URL of where the Template is hosted. Possible URL include http:// and https://', type : 'string', length : 2048, required : True}, {name : 'hypervisor', description : 'The target hypervisor for the Template', type : 'string', length : 255, required : True}, {name : 'isrouting', description : 'True if the Template type is routing i.e., if Template is used to deploy router', type : 'boolean', length : 255, required : False}, {name : 'zoneid', description : 'The ID of the zone the Template is to be hosted on', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'templatetype', description : 'the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).', type : 'string', length : 255, required : False, since : '4.19.0'}, {name : 'domainid', description : 'An optional domainId. If the account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'projectid', description : 'Register Template for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'details', description : 'Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61', type : 'map', length : 255, required : False}, {name : 'isextractable', description : 'True if the Template or its derivatives are extractable; default is false', type : 'boolean', length : 255, required : False}, {name : 'format', description : 'The format for the Template. Possible values include QCOW2, RAW, VHD and OVA.', type : 'string', length : 255, required : True}, {name : 'extensionid', description : 'ID of the extension', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listExtensions'}, {name : 'directdownload', description : 'True if Template should bypass Secondary Storage and be downloaded to Primary Storage on deployment', type : 'boolean', length : 255, required : False}, {name : 'checksum', description : 'The checksum value of this Template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.', type : 'string', length : 255, required : False}, {name : 'templatetag', description : 'The tag for this Template.', type : 'string', length : 255, required : False}, {name : 'arch', description : 'the CPU arch of the template. Valid options are: x86_64, aarch64, s390x', type : 'string', length : 255, required : False, since : '4.20'}, {name : 'zoneids', description : 'A list of zone IDs where the Template will be hosted. Use this parameter if the Template needs to be registered to multiple zones in one go. Use zoneid if the Template needs to be registered to only one zone.Passing only -1 to this will cause the Template to be registered as a cross zone Template and will be copied to all zones. ', type : 'list', length : 255, required : False, related : 'listZones'}, {name : 'ispublic', description : 'True if the Template is available to all accounts; default is true', type : 'boolean', length : 255, required : False}, {name : 'account', description : 'An optional accountName. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'forcks', description : 'if true, the templates would be available for deploying CKS clusters', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'sshkeyenabled', description : 'True if the Template supports the sshkey upload feature; default is false', type : 'boolean', length : 255, required : False}, {name : 'externaldetails', description : 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean', length : 255, required : False}], response : [{name : 'name', description : 'The Template name', type : 'string'}, {name : 'extensionid', description : 'The ID of extension linked to this template', type : 'string'}, {name : 'crossZones', description : 'True if the Template is managed across all Zones, false otherwise', type : 'boolean'}, {name : 'parenttemplateid', description : 'If Datadisk Template, then id of the root disk Template this Template belongs to', type : 'string'}, {name : 'size', description : 'The size of the Template', type : 'long'}, {name : 'accountid', description : 'The Account id to which the Template belongs', type : 'string'}, {name : 'account', description : 'The Account name to which the Template belongs', type : 'string'}, {}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', type : 'string'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {name : 'url', description : 'The URL which the Template/ISO is registered from', type : 'string'}, {name : 'userdataparams', description : 'List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'domain', description : 'The name of the domain to which the Template belongs', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'id', description : 'The Template ID', type : 'string'}, {name : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}, {name : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'hostname', description : 'The name of the secondary storage host for the Template', type : 'string'}, {name : 'userdataname', description : 'The name of userdata linked to this Template', type : 'string'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}, {name : 'zonename', description : 'The name of the zone for this Template', type : 'string'}, {name : 'userdataid', description : 'The id of userdata linked to this Template', type : 'string'}, {name : 'directdownload', description : 'KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage', type : 'boolean'}, {name : 'bits', description : 'The processor bit size', type : 'int'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'project', description : 'The project name of the Template', type : 'string'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {name : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean'}, {name : 'passwordenabled', description : 'True if the reset password feature is enabled, false otherwise', type : 'boolean'}, {name : 'checksum', description : 'Checksum of the Template', type : 'string'}, {}, {name : 'isextractable', description : 'True if the Template is extractable, false otherwise', type : 'boolean'}, {name : 'templatetag', description : 'The tag of this Template', type : 'string'}, {name : 'arch', description : 'CPU Arch of the template', type : 'string'}, {name : 'extensionname', description : 'The name of extension linked to this template', type : 'string'}, {name : 'domainid', description : 'The ID of the domain to which the Template belongs', type : 'string'}, {name : 'deployasis', description : 'VMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.', type : 'boolean'}, {}, {name : 'templatetype', description : 'The type of the Template', type : 'string'}, {name : 'ostypeid', description : 'The ID of the OS type for this Template.', type : 'string'}, {name : 'sourcetemplateid', description : 'The Template ID of the parent Template if present', type : 'string'}, {name : 'removed', description : 'The date this Template was removed', type : 'date'}, {name : 'format', description : 'The format of the Template.', type : 'imageformat'}, {name : 'sshkeyenabled', description : 'True if Template is sshkey enabled, false otherwise', type : 'boolean'}, {name : 'requireshvm', description : 'True if Template requires HVM enabled, false otherwise', type : 'boolean'}, {name : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'ispublic', description : 'True if this Template is a public Template, false otherwise', type : 'boolean'}, {name : 'isready', description : 'True if the Template is ready to be deployed from, false otherwise.', type : 'boolean'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'status', description : 'The status of the Template', type : 'string'}, {name : 'hostid', description : 'The ID of the secondary storage host for the Template', type : 'string'}, {name : 'displaytext', description : 'The Template display text', type : 'string'}], httprequesttype : 'POST'}, {name : 'listVirtualMachinesUsageHistory', description : 'Lists VM stats', since : '4.17', isasync : False, related : 'listSystemVmsUsageHistory', params : [{name : 'ids', description : 'The IDs of the Instances, mutually exclusive with id.', type : 'list', length : 255, required : False, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'name', description : 'Name of the Instance (a substring match is made against the parameter value returning the data for all matching Instances).', type : 'string', length : 255, required : False}, {name : 'enddate', description : 'End date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'startdate', description : 'Start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'id', description : 'The ID of the Instance.', type : 'uuid', length : 255, required : False, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'stats', description : 'The list of Instance stats', type : 'list', response : [{name : 'diskioread', description : "The Instance's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", type : 'long'}, {name : 'diskiowrite', description : "The Instance's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", type : 'long'}, {name : 'cpuused', description : "The amount (percentage) of the Instance's CPU currently used", type : 'string'}, {name : 'networkread', description : 'The amount of downloaded data by the Instance in MiB', type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KB', type : 'long'}, {name : 'diskiopstotal', description : 'The total disk IOPS since the last stats retrieval', type : 'long'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'memoryintfreekbs', description : "The Instance's free memory in KB or -1 if it cannot be gathered", type : 'long'}, {name : 'timestamp', description : "The time when the Instance stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'", type : 'date'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KB)', type : 'long'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'networkwrite', description : 'The amount of uploaded data by the Instance in MiB', type : 'string'}]}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'name', description : 'The Name of the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}], httprequesttype : 'GET'}, {name : 'createKubernetesCluster', description : 'Creates a Kubernetes cluster', isasync : True, related : 'startKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'dockerregistrypassword', description : 'Password for the docker image private registry', type : 'string', length : 255, required : False}, {name : 'name', description : 'Name for the Kubernetes cluster', type : 'string', length : 255, required : True}, {name : 'hypervisor', description : 'the hypervisor on which the CKS cluster is to be deployed. This is required if the zone in which the CKS cluster is being deployed has clusters with different hypervisor types.', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'zoneid', description : 'Availability zone in which Kubernetes cluster to be launched', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'dockerregistryurl', description : 'URL for the docker image private registry', type : 'string', length : 255, required : False}, {name : 'kubernetesversionid', description : 'Kubernetes version with which cluster to be launched', type : 'uuid', length : 255, required : False, related : 'getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions'}, {name : 'masternodes', description : "Number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", type : 'long', length : 255, required : False}, {name : 'domainid', description : 'An optional domainId for the Instance. If the Account parameter is used, domainId must also be used. Hosts dedicated to the specified domain will be used for deploying the cluster', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'etcdnodes', description : '(Optional) Number of Kubernetes cluster etcd nodes, default is 0.In case the number is greater than 0, etcd nodes are separate from master nodes and are provisioned accordingly', type : 'long', length : 255, required : False, since : '4.21.0'}, {name : 'nodeaffinitygroups', description : '(Optional) Node Type to Affinity Group ID mapping. If provided, VMs of each node type will be added to the specified affinity group', type : 'map', length : 255, required : False, since : '4.23.0'}, {name : 'projectid', description : 'Deploy cluster for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'keypair', description : 'Name of the SSH key pair used to login to the Instances', type : 'string', length : 255, required : False}, {name : 'nodeofferings', description : '(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'cniconfigdetails', description : 'used to specify the parameters values for the variables in userdata. Example: cniconfigdetails[0].key=accesskey&cniconfigdetails[0].value=s389ddssaa&cniconfigdetails[1].key=secretkey&cniconfigdetails[1].value=8dshfsss', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'asnumber', description : 'the AS Number of the network', type : 'long', length : 255, required : False}, {name : 'dockerregistryusername', description : 'User name for the docker image private registry', type : 'string', length : 255, required : False}, {name : 'cniconfigurationid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.21.0', related : ''}, {name : 'externalloadbalanceripaddress', description : 'External load balancer IP address while using shared network with Kubernetes HA cluster', type : 'string', length : 255, required : False}, {name : 'nodetemplates', description : '(Optional) Node Type to Template ID mapping. If provided, it overrides the default template: System VM template', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'noderootdisksize', description : 'Root disk size in GB for each node', type : 'long', length : 255, required : False}, {name : 'size', description : 'Number of Kubernetes cluster worker nodes', type : 'long', length : 255, required : False}, {name : 'networkid', description : 'Network in which Kubernetes cluster is to be launched', type : 'uuid', length : 255, required : False, related : 'createNetwork,updateNetwork,listNetworks,migrateNetwork'}, {name : 'account', description : 'An optional Account for the Instance. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'description', description : 'Description for the Kubernetes cluster', type : 'string', length : 255, required : False}, {name : 'enablecsi', description : 'if true, setups up CloudStack CSI driver', type : 'boolean', length : 255, required : False, since : '4.22.0'}, {name : 'serviceofferingid', description : 'The ID of the service offering for the Instances in the cluster.', type : 'uuid', length : 255, required : False, related : 'updateServiceOffering,listServiceOfferings'}, {name : 'controlnodes', description : 'Number of Kubernetes cluster control nodes, default is 1', type : 'long', length : 255, required : False}, {name : 'clustertype', description : 'Type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.', type : 'string', length : 255, required : False, since : '4.19.0'}], response : [{name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}], httprequesttype : 'POST'}, {name : 'updateVMAffinityGroup', description : 'Updates the affinity/anti-affinity group associations of an Instance. The Instance has to be stopped and restarted for the new properties to take effect.', isasync : True, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm', params : [{name : 'affinitygroupids', description : 'Comma separated list of affinity groups id that are going to be applied to the Instance. Should be passed only when Instance is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter', type : 'list', length : 255, required : False, related : ''}, {name : 'affinitygroupnames', description : 'Comma separated list of affinity groups names that are going to be applied to the Instance. Should be passed only when Instance is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter', type : 'list', length : 255, required : False, related : ''}, {name : 'id', description : 'The ID of the Instance', type : 'uuid', length : 255, required : True, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}], response : [{name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}]}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}]}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}, {name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'name', description : 'The name of the attached ISO', type : 'string'}]}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}]}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'value', description : 'Tag value', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}]}, {name : 'projectid', description : 'The project id of the group', type : 'string'}]}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}]}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}], httprequesttype : 'POST'}, {name : 'updateWebhook', description : 'Updates a Webhook', since : '4.20.0', isasync : False, related : 'createWebhook', params : [{name : 'payloadurl', description : 'Payload URL of the Webhook', type : 'string', length : 255, required : False}, {name : 'scope', description : 'Scope of the Webhook', type : 'string', length : 255, required : False}, {name : 'sslverification', description : 'If set to true then SSL verification will be done for the Webhook otherwise not', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'Name for the Webhook', type : 'string', length : 255, required : False}, {name : 'description', description : 'Description for the Webhook', type : 'string', length : 255, required : False}, {name : 'state', description : 'State of the Webhook', type : 'string', length : 255, required : False}, {name : 'secretkey', description : 'Secret key of the Webhook', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : True, related : 'createWebhook,updateWebhook'}], response : [{name : 'secretkey', description : 'The secret key for the Webhook', type : 'string'}, {name : 'description', description : 'The description of the Webhook', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'projectid', description : 'the project id of the Kubernetes cluster', type : 'string'}, {name : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}, {name : 'account', description : 'The account associated with the Webhook', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Webhook exists', type : 'string'}, {name : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {name : 'project', description : 'the project name of the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Webhook exists', type : 'string'}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {name : 'created', description : 'The date when this Webhook was created', type : 'date'}], httprequesttype : 'POST'}, {name : 'listCaCertificate', description : 'Lists the CA public certificate(s) as support by the configured/provided CA plugin', since : '4.11.0', isasync : False, related : '', params : [{name : 'provider', description : 'Name of the CA service provider, otherwise the default configured provider plugin will be used', type : 'string', length : 255, required : False}], response : [{name : 'privatekey', description : 'Private key for the certificate', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'cacertificates', description : 'The CA certificate(s)', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'certificate', description : 'The client certificate', type : 'string'}, {}], httprequesttype : 'GET'}, {name : 'updateProjectRole', description : 'Creates a Project role', since : '4.15.0', isasync : False, related : '', params : [{name : 'projectid', description : 'ID of project where role is being created', type : 'uuid', length : 255, required : True, related : ''}, {name : 'description', description : 'The description of the Project role', type : 'string', length : 255, required : False}, {name : 'id', description : 'ID of the Project role', type : 'uuid', length : 255, required : True, related : 'updateProjectRole'}, {name : 'name', description : 'Creates a project role with this unique name', type : 'string', length : 255, required : False}], response : [{name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'description', description : 'The description of the role', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'The name of the role', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'id', description : 'The ID of the role', type : 'string'}, {name : 'ispublic', description : 'Indicates whether the role will be visible to all Users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listImportVmTasks', description : 'List running import virtual machine tasks from a unmanaged hosts into CloudStack', since : '4.22', isasync : False, related : '', params : [{name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'tasksfilter', description : 'Filter tasks by state, valid options are: All, Running, Completed, Failed', type : 'string', length : 255, required : False}, {name : 'convertinstancehostid', description : 'Conversion host of the importing task', type : 'uuid', length : 255, required : False, related : 'reconnectHost'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'vcenter', description : 'The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.', type : 'string', length : 255, required : False}, {name : 'accountid', description : 'the ID of the Account', type : 'uuid', length : 255, required : False, related : 'enableAccount,listAccounts'}], response : [{name : 'description', description : 'the current step description on the importing VM task', type : 'string'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'virtualmachineid', description : 'the ID of the imported VM (after task is completed)', type : 'string'}, {name : 'displayname', description : 'the display name of the importing VM', type : 'string'}, {name : 'convertinstancehostname', description : 'the name of the host on which the instance is being converted', type : 'string'}, {name : 'state', description : 'the state of the importing VM task', type : 'string'}, {name : 'duration', description : 'the total task duration', type : 'string'}, {name : 'convertinstancehostid', description : 'the ID of the host on which the instance is being converted', type : 'string'}, {name : 'accountid', description : 'the ID of account', type : 'string'}, {name : 'created', description : 'the create date of the importing task', type : 'date'}, {name : 'stepduration', description : 'the duration of the current step', type : 'string'}, {name : 'zonename', description : 'the Zone name', type : 'string'}, {name : 'step', description : 'the current step on the importing VM task', type : 'string'}, {name : 'vcenter', description : 'the vcenter name of the importing VM task', type : 'string'}, {name : 'lastupdated', description : 'the last updated date of the importing task', type : 'date'}, {}, {name : 'id', description : 'the ID of importing task', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'sourcevmname', description : 'the source VM name', type : 'string'}, {name : 'zoneid', description : 'the Zone ID', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'datacentername', description : 'the datacenter name of the importing VM task', type : 'string'}], httprequesttype : 'GET'}, {name : 'changeSharedFileSystemDiskOffering', description : 'Change Disk offering of a Shared FileSystem', since : '4.20.0', isasync : True, related : '', params : [{name : 'maxiops', description : 'max iops', type : 'long', length : 255, required : False}, {name : 'miniops', description : 'min iops', type : 'long', length : 255, required : False}, {name : 'size', description : 'the size of the shared filesystem in GiB', type : 'long', length : 255, required : False}, {name : 'diskofferingid', description : 'the disk offering to use for the underlying storage', type : 'uuid', length : 255, required : False, related : ''}, {name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'changeSharedFileSystemDiskOffering'}], response : [{name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}]}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}], httprequesttype : 'POST'}, {name : 'createKMSKey', description : 'Creates a new KMS key (Key Encryption Key) for encryption', since : '4.23.0', isasync : False, related : 'updateKMSKey', params : [{name : 'name', description : 'Name of the KMS key', type : 'string', length : 255, required : True}, {name : 'description', description : 'Description of the KMS key', type : 'string', length : 255, required : False}, {name : 'keybits', description : 'Key size in bits: 128, 192, or 256 (default: 256)', type : 'integer', length : 255, required : False}, {name : 'projectid', description : 'ID of the project to create the KMS key for', type : 'uuid', length : 255, required : False, related : ''}, {name : 'account', description : 'Account name (for creating keys for child accounts - requires domain admin or admin)', type : 'string', length : 255, required : False}, {name : 'hsmprofileid', description : 'ID of HSM profile to create key in', type : 'uuid', length : 255, required : True, related : ''}, {name : 'domainid', description : 'Domain ID (for creating keys for child accounts - requires domain admin or admin)', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'zoneid', description : 'Zone ID where the key will be valid', type : 'uuid', length : 255, required : True, related : 'listZones'}], response : [{name : 'domainid', description : 'the domain ID of the key', type : 'string'}, {name : 'projectid', description : 'the project ID of the key', type : 'string'}, {}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainpath', description : 'the domain path of the key', type : 'string'}, {name : 'hsmprofile', description : 'the zone name where the key is valid', type : 'string'}, {name : 'name', description : 'the name of the key', type : 'string'}, {name : 'account', description : 'the account owning the key', type : 'string'}, {name : 'enabled', description : 'whether the key is enabled', type : 'boolean'}, {name : 'zonename', description : 'the zone name where the key is valid', type : 'string'}, {name : 'algorithm', description : 'the encryption algorithm', type : 'string'}, {name : 'accountid', description : 'the account ID owning the key', type : 'string'}, {name : 'domain', description : 'the domain name of the key', type : 'string'}, {name : 'keklabel', description : 'the provider-specific KEK label (admin only)', type : 'string'}, {name : 'description', description : 'the description of the key', type : 'string'}, {name : 'hsmprofileid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'created', description : 'the creation timestamp', type : 'date'}, {name : 'id', description : 'the UUID of the key', type : 'string'}, {name : 'keybits', description : 'the key size in bits', type : 'integer'}, {name : 'zoneid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'version', description : 'the key size in bits', type : 'integer'}, {name : 'project', description : 'the project name of the key', type : 'string'}], httprequesttype : 'POST'}, {name : 'expungeSharedFileSystem', description : 'Expunge a Shared FileSystem by id', since : '4.20.0', isasync : True, params : [{name : 'id', description : 'the ID of the shared filesystem to expunge', type : 'uuid', length : 255, required : False, related : ''}], response : [{}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'getUploadParamsForTemplate', description : 'Upload an existing Template into the CloudStack cloud. ', since : '4.6.0', isasync : False, related : 'getUploadParamsForIso', params : [{name : 'name', description : 'The name of the Volume/Template/ISO', type : 'string', length : 255, required : True}, {name : 'deployasis', description : '(VMware only) true if Instance deployments should preserve all the configurations defined for this Template', type : 'boolean', length : 255, required : False, since : '4.15.1'}, {name : 'templatetag', description : 'The tag for this Template.', type : 'string', length : 255, required : False}, {name : 'sshkeyenabled', description : 'True if the Template supports the SSHkey upload feature; default is false', type : 'boolean', length : 255, required : False}, {name : 'ostypeid', description : 'The ID of the OS Type that best represents the OS of this Template. Not required for VMware as the guest OS is obtained from the OVF file.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'projectid', description : 'Upload Volume/Template/ISO for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'account', description : 'An optional accountName. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean', length : 255, required : False}, {name : 'hypervisor', description : 'The target hypervisor for the Template', type : 'string', length : 255, required : True}, {name : 'templatetype', description : 'the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).', type : 'string', length : 255, required : False, since : '4.22.0'}, {name : 'ispublic', description : 'True if the Template is available to all accounts; default is true', type : 'boolean', length : 255, required : False}, {name : 'passwordenabled', description : 'True if the Template supports the password reset feature; default is false', type : 'boolean', length : 255, required : False}, {name : 'bits', description : '32 or 64 bits support. 64 by default', type : 'integer', length : 255, required : False}, {name : 'displaytext', description : 'The display text of the Template. This is usually used for display purposes.', type : 'string', length : 4096, required : False}, {name : 'arch', description : 'the CPU arch of the template. Valid options are: x86_64, aarch64, s390x', type : 'string', length : 255, required : False, since : '4.20'}, {name : 'checksum', description : 'The checksum value of this Volume/Template/ISO The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.', type : 'string', length : 255, required : False}, {name : 'format', description : 'The format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.', type : 'string', length : 255, required : True}, {name : 'forcks', description : 'if true, the templates would be available for deploying CKS clusters', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'details', description : 'Template details in key/value pairs.', type : 'map', length : 255, required : False}, {name : 'zoneid', description : 'The ID of the zone the Volume/Template/ISO is to be hosted on', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'isrouting', description : 'True if the Template type is routing i.e., if Template is used to deploy router', type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'An optional domainId. If the Account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean', length : 255, required : False}, {name : 'isextractable', description : 'True if the Template or its derivatives are extractable; default is false', type : 'boolean', length : 255, required : False}, {name : 'requireshvm', description : 'True if this Template requires HVM', type : 'boolean', length : 255, required : False}], response : [{name : 'signature', description : 'Signature to be sent in the POST request.', type : 'string'}, {name : 'id', description : 'The Template/volume ID', type : 'uuid'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'metadata', description : 'Encrypted data to be sent in the POST request.', type : 'string'}, {name : 'expires', description : 'The timestamp after which the signature expires', type : 'string'}, {name : 'postURL', description : 'POST url to upload the file to', type : 'url'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'listAutoScaleVmProfiles', description : 'Lists autoscale Instance profiles.', isasync : False, related : '', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'zoneid', description : 'Availability zone for the auto deployed Instance', type : 'uuid', length : 255, required : False, since : '4.4', related : 'listZones'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'otherdeployparams', description : 'The otherdeployparameters of the autoscale Instance profile', type : 'string', length : 255, required : False}, {name : 'templateid', description : 'The templateid of the autoscale Instance profile', type : 'uuid', length : 255, required : False, related : 'registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'id', description : 'The ID of the autoscale Instance profile', type : 'uuid', length : 255, required : False, related : 'listAutoScaleVmProfiles'}, {name : 'fordisplay', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'serviceofferingid', description : 'List profiles by service offering id', type : 'uuid', length : 255, required : False, since : '4.4', related : 'updateServiceOffering,listServiceOfferings'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}], response : [{name : 'autoscaleuserid', description : 'The ID of the User used to launch and destroy the Instances', type : 'string'}, {name : 'userdataid', description : 'the id of userdata used for the VM', type : 'string'}, {name : 'zoneid', description : 'The availability zone to be used while deploying an Instance', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the vm profile belongs', type : 'string'}, {name : 'serviceofferingid', description : 'The service offering to be used while deploying an Instance', type : 'string'}, {name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance', type : 'map'}, {name : 'fordisplay', description : 'Is profile for display to the regular User', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'userdatapolicy', description : 'the userdata override policy with the userdata provided while deploying VM', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer'}, {name : 'id', description : 'The autoscale Instance profile ID', type : 'string'}, {name : 'userdata', description : 'Base64 encoded Instance user data', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance profile', type : 'string'}, {name : 'templateid', description : 'The Template to be used while deploying an Instance', type : 'string'}, {name : 'projectid', description : 'The project id Instance profile', type : 'string'}, {name : 'userdatadetails', description : 'list of variables and values for the variables declared in userdata', type : 'string'}, {}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'userdataname', description : 'the name of userdata used for the VM', type : 'string'}, {name : 'project', description : 'The project name of the Instance profile', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance profile', type : 'string'}, {}], httprequesttype : 'GET'}, {name : 'updateBucket', description : 'Updates Bucket properties', since : '4.19.0', isasync : False, params : [{name : 'policy', description : 'Bucket Access Policy', type : 'string', length : 255, required : False}, {name : 'versioning', description : 'Enable/Disable Bucket Versioning', type : 'boolean', length : 255, required : False}, {name : 'quota', description : 'Bucket Quota in GiB', type : 'integer', length : 255, required : False}, {name : 'encryption', description : 'Enable/Disable Bucket encryption', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The ID of the Bucket', type : 'uuid', length : 255, required : True, related : ''}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listDnsProviders', description : 'Lists available DNS plugin providers', since : '4.23.0', isasync : False, related : '', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{}, {name : 'name', description : 'The name of the DNS provider (e.g. PowerDNS, Cloudflare)', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'listTungstenFabricVm', description : 'List Tungsten-Fabric vm', isasync : False, related : '', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'vmuuid', description : 'The uuid of Tungsten-Fabric vm', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'The ID of zone', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'uuid', description : 'Tungsten-Fabric nic uuid', type : 'string'}, {}, {}, {name : 'zonename', description : 'Tungsten-Fabric provider zone name', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zoneid', description : 'Tungsten-Fabric provider zone id', type : 'long'}, {name : 'name', description : 'Tungsten-Fabric vm name', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'createWebhook', description : 'Creates a Webhook', since : '4.20.0', isasync : False, related : '', params : [{name : 'name', description : 'Name for the Webhook', type : 'string', length : 255, required : True}, {name : 'secretkey', description : 'Secret key of the Webhook', type : 'string', length : 255, required : False}, {name : 'scope', description : 'Scope of the Webhook', type : 'string', length : 255, required : False}, {name : 'sslverification', description : 'If set to true then SSL verification will be done for the Webhook otherwise not', type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'an optional domainId for the Webhook. If the account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'account', description : 'An optional account for the Webhook. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'state', description : 'State of the Webhook', type : 'string', length : 255, required : False}, {name : 'payloadurl', description : 'Payload URL of the Webhook', type : 'string', length : 255, required : True}, {name : 'description', description : 'Description for the Webhook', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'Project for the Webhook', type : 'uuid', length : 255, required : False, related : ''}], response : [{name : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {name : 'created', description : 'The date when this Webhook was created', type : 'date'}, {}, {name : 'description', description : 'The description of the Webhook', type : 'string'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {name : 'account', description : 'The account associated with the Webhook', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}, {name : 'secretkey', description : 'The secret key for the Webhook', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainid', description : 'The ID of the domain in which the Webhook exists', type : 'string'}, {name : 'projectid', description : 'the project id of the Kubernetes cluster', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Webhook exists', type : 'string'}, {name : 'project', description : 'the project name of the Kubernetes cluster', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'updateKubernetesClusterAffinityGroups', description : 'Updates the affinity group mappings for a stopped Kubernetes cluster', since : '4.23.0', isasync : False, related : 'startKubernetesCluster', params : [{name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'startKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {name : 'nodeaffinitygroups', description : 'Node Type to Affinity Group ID mapping. VMs of each node type will be added to the specified affinity group', type : 'map', length : 255, required : False, since : '4.23.0'}], response : [{name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteResourceSchedule', description : 'Delete Resource Schedule', since : '4.23.0', isasync : False, params : [{name : 'resourceid', description : 'ID of the resource for which schedules are to be deleted', type : 'string', length : 255, required : True}, {name : 'ids', description : 'comma separated list of schedule ids to be deleted', type : 'list', length : 255, required : False, related : ''}, {name : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : True}, {name : 'id', description : 'ID of the schedule to be deleted', type : 'uuid', length : 255, required : False, related : ''}], response : [{}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'listKubernetesSupportedVersions', description : 'Lists supported Kubernetes version', isasync : False, related : 'getUploadParamsForKubernetesSupportedVersion', params : [{name : 'minimumkubernetesversionid', description : 'The ID of the minimum Kubernetes supported version', type : 'uuid', length : 255, required : False, related : 'getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the Kubernetes supported version', type : 'uuid', length : 255, required : False, related : 'getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions'}, {name : 'arch', description : 'the CPU arch of the binaries ISO. Valid options are: x86_64, aarch64, s390x', type : 'string', length : 255, required : False, since : '4.20'}, {name : 'minimumsemanticversion', description : 'The minimum semantic version for the Kubernetes supported version to be listed', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'The ID of the zone in which Kubernetes supported version will be available', type : 'uuid', length : 255, required : False, related : 'listZones'}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zoneid', description : 'The ID of the zone in which Kubernetes supported version is available', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes supported version was created', type : 'date'}, {name : 'isourl', description : 'the URL of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'arch', description : 'the arch of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'supportsautoscaling', description : 'Whether Kubernetes supported version supports Autoscaling', type : 'boolean'}, {name : 'isoid', description : 'The ID of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes supported version', type : 'string'}, {name : 'state', description : 'The enabled or disabled state of the Kubernetes supported version', type : 'string'}, {name : 'supportsha', description : 'Whether Kubernetes supported version supports HA, multi-control nodes', type : 'boolean'}, {name : 'directdownload', description : 'KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage', type : 'boolean'}, {name : 'zonename', description : 'The name of the zone in which Kubernetes supported version is available', type : 'string'}, {}, {}, {name : 'isoname', description : 'The name of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'Name of the Kubernetes supported version', type : 'string'}, {name : 'semanticversion', description : 'Kubernetes semantic version', type : 'string'}, {name : 'mincpunumber', description : 'The minimum number of CPUs needed for the Kubernetes supported version', type : 'integer'}, {name : 'minmemory', description : 'The minimum RAM size in MB needed for the Kubernetes supported version', type : 'integer'}, {name : 'isostate', description : 'The state of the binaries ISO for Kubernetes supported version', type : 'string'}], httprequesttype : 'GET'}, {name : 'recoverVolume', description : 'Recovers a Destroy volume.', since : '4.14.0', isasync : False, related : 'createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume', params : [{name : 'id', description : 'The ID of the volume', type : 'uuid', length : 255, required : True, related : 'createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume'}], response : [{name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'deviceid', description : 'The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.', type : 'long'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {name : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {}, {name : 'vmstate', description : 'State of the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}], httprequesttype : 'POST'}, {name : 'listVnfAppliances', description : 'List VNF appliance owned by the account.', since : '4.19.1', isasync : False, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,importVm', params : [{name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'isvnf', description : 'flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.', type : 'boolean', length : 255, required : False, since : '4.19.0'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'leased', description : 'Whether to return only leased instances', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'id', description : 'The ID of the Instance', type : 'uuid', length : 255, required : False, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string', length : 255, required : False, since : '4.20.1'}, {name : 'groupid', description : 'The group ID', type : 'uuid', length : 255, required : False, related : ''}, {name : 'userid', description : 'The user ID that created the Instance and is under the Account that owns the Instance', type : 'uuid', length : 255, required : False, related : 'getUser'}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", type : 'boolean', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'isoid', description : 'List Instances by ISO', type : 'uuid', length : 255, required : False}, {name : 'hypervisor', description : 'The target hypervisor for the Template', type : 'string', length : 255, required : False}, {name : 'vpcid', description : 'List Instances by VPC', type : 'uuid', length : 255, required : False, related : 'createVPC,listVPCs,updateVPC'}, {name : 'userdata', description : "Whether to return the Instances' User data or not. By default, User data will not be returned.", type : 'boolean', length : 255, required : False, since : '4.18.0.0'}, {name : 'keypair', description : 'List Instances by SSH keypair name', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'templateid', description : 'List Instances by Template', type : 'uuid', length : 255, required : False, related : 'listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'zoneid', description : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,updateNetwork,listNetworks'}, {name : 'name', description : 'Name of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)', type : 'string', length : 255, required : False}, {name : 'displayvm', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'autoscalevmgroupid', description : 'The ID of AutoScaling Instance Group', type : 'uuid', length : 255, required : False, since : '4.18.0', related : ''}, {name : 'serviceofferingid', description : 'List by the service offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'updateServiceOffering,listServiceOfferings'}, {name : 'details', description : 'Comma separated list of Instance details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.', type : 'list', length : 255, required : False}, {name : 'state', description : 'State of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.', type : 'string', length : 255, required : False}, {name : 'gpuenabled', description : 'Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'securitygroupid', description : 'The security group ID', type : 'uuid', length : 255, required : False, since : '4.15', related : ''}, {name : 'haenable', description : 'List by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabled', type : 'boolean', length : 255, required : False, since : '4.15'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'accumulate', description : 'Accumulates the Instance metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.', type : 'boolean', length : 255, required : False, since : '4.17.0'}, {name : 'affinitygroupid', description : 'List Instances by affinity group', type : 'uuid', length : 255, required : False, related : ''}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'userdataid', description : 'the instances by userdata', type : 'uuid', length : 255, required : False, since : '4.20.1', related : ''}, {name : 'ids', description : 'The IDs of the Instances, mutually exclusive with id', type : 'list', length : 255, required : False, since : '4.4', related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'showicon', description : 'Flag to display the resource icon for Instances', type : 'boolean', length : 255, required : False, since : '4.16.0.0'}, {name : 'forvirtualnetwork', description : 'List by Network type; true if need to list Instances using Virtual Network, false otherwise', type : 'boolean', length : 255, required : False}, {name : 'backupofferingid', description : 'List by the backup offering', type : 'uuid', length : 255, required : False, since : '4.17', related : ''}, {name : 'extensionid', description : 'The ID of the Orchestrator extension for the VM', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listExtensions'}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}], response : [{name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}]}, {}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}]}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}]}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}]}]}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}]}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}], httprequesttype : 'GET'}, {name : 'listSystemVmsUsageHistory', description : 'Lists System VM stats', since : '4.18.0', isasync : False, related : '', params : [{name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'enddate', description : 'End date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'id', description : 'The ID of the system VM.', type : 'uuid', length : 255, required : False, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,importVm'}, {name : 'ids', description : 'The IDs of the System VMs, mutually exclusive with ID.', type : 'list', length : 255, required : False, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,importVm'}, {name : 'startdate', description : 'Start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'name', description : 'Name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'stats', description : 'The list of Instance stats', type : 'list', response : [{name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'timestamp', description : "The time when the Instance stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'", type : 'date'}, {name : 'diskioread', description : "The Instance's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", type : 'long'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'diskiopstotal', description : 'The total disk IOPS since the last stats retrieval', type : 'long'}, {name : 'cpuused', description : "The amount (percentage) of the Instance's CPU currently used", type : 'string'}, {name : 'networkread', description : 'The amount of downloaded data by the Instance in MiB', type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KB', type : 'long'}, {name : 'networkwrite', description : 'The amount of uploaded data by the Instance in MiB', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KB)', type : 'long'}, {name : 'diskiowrite', description : "The Instance's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", type : 'long'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'memoryintfreekbs', description : "The Instance's free memory in KB or -1 if it cannot be gathered", type : 'long'}]}, {}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'The Name of the Instance', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}], httprequesttype : 'GET'}, {name : 'deleteIpv6FirewallRule', description : 'Deletes a IPv6 firewall rule', isasync : True, params : [{name : 'id', description : 'The ID of the IPv6 firewall rule', type : 'uuid', length : 255, required : True, related : ''}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'listVMSnapshot', description : 'List Instance Snapshot by conditions', since : '4.2.0', isasync : False, related : 'createVMSnapshot', params : [{name : 'vmsnapshotids', description : 'The IDs of the Instance Snapshots, mutually exclusive with vmsnapshotid', type : 'list', length : 255, required : False, since : '4.9', related : 'listVMSnapshot,createVMSnapshot'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'Lists Snapshot by Snapshot name or display name', type : 'string', length : 255, required : False}, {name : 'virtualmachineid', description : 'The ID of the Instance', type : 'uuid', length : 255, required : False, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,importVm'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'vmsnapshotid', description : 'The ID of the Instance Snapshot', type : 'uuid', length : 255, required : False, related : 'listVMSnapshot,createVMSnapshot'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'state', description : 'State of the Instance Snapshot', type : 'string', length : 255, required : False}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'The ID of the Instance Snapshot', type : 'string'}, {name : 'current', description : 'Indicates if this is current Snapshot', type : 'boolean'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {}, {name : 'created', description : 'The create date of the Instance Snapshot', type : 'date'}, {name : 'hypervisor', description : 'The type of hypervisor on which Snapshot is stored', type : 'string'}, {name : 'type', description : 'Instance Snapshot type', type : 'string'}, {name : 'state', description : 'The state of the Instance Snapshot', type : 'state'}, {name : 'domainpath', description : 'Path of the domain to which the disk volume belongs', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'parent', description : 'The parent ID of the Instance Snapshot', type : 'string'}, {name : 'name', description : 'The name of the Instance Snapshot', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'zoneid', description : 'The Zone ID of the Instance Snapshot', type : 'string'}, {name : 'zonename', description : 'The Zone name of the Instance Snapshot', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'virtualmachineid', description : 'The Instance ID of the Instance Snapshot', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name of the Instance Snapshot', type : 'string'}, {}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'projectid', description : 'The project ID of the VPN', type : 'string'}, {name : 'displayname', description : 'The display name of the Instance Snapshot', type : 'string'}, {name : 'parentName', description : 'The parent displayName of the Instance Snapshot', type : 'string'}, {name : 'description', description : 'The description of the Instance Snapshot', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateKMSKey', description : 'Updates KMS key name, description, or enabled status', since : '4.23.0', isasync : False, related : '', params : [{name : 'description', description : 'New description for the key', type : 'string', length : 255, required : False}, {name : 'name', description : 'New name for the key', type : 'string', length : 255, required : False}, {name : 'enabled', description : 'whether the key should be enabled', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The UUID of the KMS key to update', type : 'uuid', length : 255, required : True, related : 'updateKMSKey'}], response : [{name : 'domainid', description : 'the domain ID of the key', type : 'string'}, {name : 'account', description : 'the account owning the key', type : 'string'}, {name : 'hsmprofile', description : 'the zone name where the key is valid', type : 'string'}, {name : 'accountid', description : 'the account ID owning the key', type : 'string'}, {name : 'id', description : 'the UUID of the key', type : 'string'}, {name : 'domain', description : 'the domain name of the key', type : 'string'}, {name : 'version', description : 'the key size in bits', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'description', description : 'the description of the key', type : 'string'}, {name : 'domainpath', description : 'the domain path of the key', type : 'string'}, {}, {name : 'projectid', description : 'the project ID of the key', type : 'string'}, {name : 'keklabel', description : 'the provider-specific KEK label (admin only)', type : 'string'}, {name : 'zonename', description : 'the zone name where the key is valid', type : 'string'}, {}, {name : 'project', description : 'the project name of the key', type : 'string'}, {name : 'hsmprofileid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'zoneid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'algorithm', description : 'the encryption algorithm', type : 'string'}, {name : 'enabled', description : 'whether the key is enabled', type : 'boolean'}, {name : 'created', description : 'the creation timestamp', type : 'date'}, {name : 'name', description : 'the name of the key', type : 'string'}, {name : 'keybits', description : 'the key size in bits', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listApis', description : 'Lists all available APIs on the server, provided by the API Discovery plugin', since : '4.1.0', isasync : False, related : '', params : [{name : 'name', description : 'API name', type : 'string', length : 255, required : False}], response : [{name : 'type', description : 'Response field type', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'The name of the API command', type : 'string'}, {name : 'description', description : 'Description of the API', type : 'string'}, {name : 'related', description : 'Comma separated related apis', type : 'string'}, {name : 'params', description : 'The list params the api accepts', type : 'set', response : [{name : 'since', description : 'Version of CloudStack the API was introduced in', type : 'string'}, {}, {name : 'related', description : 'Comma separated related APIs to get the parameter', type : 'string'}, {name : 'name', description : 'The name of the API parameter', type : 'string'}, {name : 'type', description : 'Parameter type', type : 'string'}, {name : 'length', description : 'Length of the parameter', type : 'int'}, {name : 'required', description : 'True if this parameter is required for the API request', type : 'boolean'}, {name : 'description', description : 'Description of the API parameter', type : 'string'}]}, {name : 'response', description : 'API response fields', type : 'set', response : [{name : 'response', description : 'API response fields', type : 'set'}, {name : 'description', description : 'Description of the API response field', type : 'string'}, {name : 'type', description : 'Response field type', type : 'string'}, {name : 'name', description : 'The name of the API response field', type : 'string'}]}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'isasync', description : 'True if API is asynchronous', type : 'boolean'}, {name : 'since', description : 'Version of CloudStack the API was introduced in', type : 'string'}, {name : 'httprequesttype', description : 'Preferred HTTP request type for the API', type : 'string'}], httprequesttype : 'GET'}, {name : 'createVMSnapshot', description : 'Creates Snapshot for an Instance.', since : '4.2.0', isasync : True, related : '', params : [{name : 'name', description : 'The display name of the Snapshot', type : 'string', length : 255, required : False}, {name : 'snapshotmemory', description : 'Snapshot memory if true', type : 'boolean', length : 255, required : False}, {name : 'virtualmachineid', description : 'The ID of the Instance', type : 'uuid', length : 255, required : True, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,importVm'}, {name : 'description', description : 'The description of the Snapshot', type : 'string', length : 255, required : False}, {name : 'quiescevm', description : 'Quiesce Instance if true', type : 'boolean', length : 255, required : False}], response : [{}, {name : 'created', description : 'The create date of the Instance Snapshot', type : 'date'}, {name : 'projectid', description : 'The project ID of the VPN', type : 'string'}, {name : 'parentName', description : 'The parent displayName of the Instance Snapshot', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'value', description : 'Tag value', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zoneid', description : 'The Zone ID of the Instance Snapshot', type : 'string'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'hypervisor', description : 'The type of hypervisor on which Snapshot is stored', type : 'string'}, {name : 'current', description : 'Indicates if this is current Snapshot', type : 'boolean'}, {name : 'zonename', description : 'The Zone name of the Instance Snapshot', type : 'string'}, {name : 'name', description : 'The name of the Instance Snapshot', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'state', description : 'The state of the Instance Snapshot', type : 'state'}, {name : 'domainpath', description : 'Path of the domain to which the disk volume belongs', type : 'string'}, {}, {name : 'id', description : 'The ID of the Instance Snapshot', type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID of the Instance Snapshot', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name of the Instance Snapshot', type : 'string'}, {name : 'description', description : 'The description of the Instance Snapshot', type : 'string'}, {name : 'parent', description : 'The parent ID of the Instance Snapshot', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'type', description : 'Instance Snapshot type', type : 'string'}, {name : 'displayname', description : 'The display name of the Instance Snapshot', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'getUploadParamsForIso', description : 'Upload an existing ISO into the CloudStack cloud.', since : '4.13', isasync : False, related : '', params : [{name : 'isextractable', description : 'True if the ISO or its derivatives are extractable; default is false', type : 'boolean', length : 255, required : False}, {name : 'projectid', description : 'Upload Volume/Template/ISO for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'isfeatured', description : 'True if you want this ISO to be featured', type : 'boolean', length : 255, required : False}, {name : 'zoneid', description : 'The ID of the zone the Volume/Template/ISO is to be hosted on', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'format', description : 'The format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.', type : 'string', length : 255, required : True}, {name : 'displaytext', description : 'The display text of the ISO. This is usually used for display purposes.', type : 'string', length : 4096, required : False}, {name : 'account', description : 'An optional accountName. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'name', description : 'The name of the Volume/Template/ISO', type : 'string', length : 255, required : True}, {name : 'domainid', description : 'An optional domainId. If the Account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'bootable', description : 'True if this ISO is bootable. If not passed explicitly its assumed to be true', type : 'boolean', length : 255, required : False}, {name : 'ostypeid', description : 'The ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed', type : 'uuid', length : 255, required : False, related : ''}, {name : 'checksum', description : 'The checksum value of this Volume/Template/ISO The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.', type : 'string', length : 255, required : False}, {name : 'ispublic', description : 'True if you want to register the ISO to be publicly available to all Users, false otherwise.', type : 'boolean', length : 255, required : False}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'postURL', description : 'POST url to upload the file to', type : 'url'}, {name : 'expires', description : 'The timestamp after which the signature expires', type : 'string'}, {name : 'signature', description : 'Signature to be sent in the POST request.', type : 'string'}, {}, {name : 'id', description : 'The Template/volume ID', type : 'uuid'}, {}, {name : 'metadata', description : 'Encrypted data to be sent in the POST request.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'deleteAutoScaleVmGroup', description : 'Deletes an autoscale Instance group.', isasync : True, params : [{name : 'cleanup', description : 'True if all VMs have to be cleaned up, false otherwise', type : 'boolean', length : 255, required : False, since : '4.18.0'}, {name : 'id', description : 'The ID of the autoscale group', type : 'uuid', length : 255, required : True, related : ''}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'listUserKeys', description : 'Lists the API key pairs (API and secret keys) of a user.', since : '4.23.0', isasync : False, related : '', params : [{name : 'userid', description : 'ID of the user that owns the keys.', type : 'uuid', length : 255, required : False, related : 'getUser'}, {name : 'apikeyfilter', description : 'API key of the key pair.', type : 'string', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'listall', description : 'Lists all API key pairs of users that are accessible by the calling account. Only available for administrators. Defaults to false.', type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'showpermissions', description : 'Whether API Key rules should be returned. Defaults to false.', type : 'boolean', length : 255, required : False}, {name : 'keypairid', description : 'ID of the key pair.', type : 'uuid', length : 255, required : False, related : 'listUserKeys'}], response : [{name : 'name', description : 'Name of the API key pair', type : 'string'}, {name : 'description', description : 'API key pair description.', type : 'string'}, {name : 'domain', description : 'Name of the domain which the account belongs to.', type : 'string'}, {name : 'apikey', description : 'The API key of the registered user.', type : 'string'}, {name : 'roleid', description : 'ID of the role.', type : 'string'}, {name : 'rolename', description : 'Name of the role.', type : 'string'}, {name : 'accountname', description : 'Account name.', type : 'string'}, {name : 'state', description : 'State of the API key pair.', type : 'apikeypairstate'}, {name : 'roletype', description : 'Type of the role (Admin, ResourceAdmin, DomainAdmin, User).', type : 'string'}, {name : 'accountid', description : 'Account ID.', type : 'string'}, {name : 'userid', description : 'ID of the user that owns the keypair.', type : 'string'}, {name : 'secretkey', description : 'The secret key of the registered user.', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainpath', description : 'Path of the domain which the account belongs to.', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {}, {name : 'permissions', description : 'Permissions of the API key pair.', type : 'list'}, {}, {name : 'domainid', description : 'ID of the domain which the account belongs to.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'ID of the API key pair.', type : 'string'}, {name : 'startdate', description : 'API key pair start date.', type : 'date'}, {name : 'enddate', description : 'API key pair expiration date.', type : 'date'}, {name : 'accounttype', description : 'Account type.', type : 'string'}, {name : 'username', description : "Username of the keypair's owner.", type : 'string'}, {name : 'created', description : 'API key pair creation timestamp.', type : 'date'}], httprequesttype : 'GET'}, {name : 'startKubernetesCluster', description : 'Starts a stopped CloudManaged Kubernetes cluster', isasync : True, related : '', params : [{name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'startKubernetesCluster'}], response : [{name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listSharedFileSystemProviders', description : 'Lists all available shared filesystem providers.', since : '4.20.0', isasync : False, related : '', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'name', description : 'the name of the shared filesystem provider', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'listBackupSchedule', description : 'List backup schedule of an Instance', since : '4.14.0', isasync : False, related : '', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'the ID of the backup schedule', type : 'uuid', length : 255, required : False, since : '4.22.0', related : 'listBackupSchedule'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'uuid', length : 255, required : False, related : 'scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,importVm'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}], response : [{name : 'id', description : 'ID of the backup schedule.', type : 'string'}, {name : 'intervaltype', description : 'The interval type of the backup schedule', type : 'intervaltype'}, {}, {}, {name : 'quiescevm', description : 'quiesce the instance before checkpointing the disks for backup', type : 'boolean'}, {name : 'timezone', description : 'The time zone of the backup schedule', type : 'string'}, {name : 'maxbackups', description : 'maximum number of backups retained', type : 'integer'}, {name : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'schedule', description : 'The time the backup is scheduled to be taken.', type : 'string'}, {name : 'isolated', description : 'Whether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'restoreVolumeFromBackupAndAttachToVM', description : 'Restore and attach a backed up volume to Instance', since : '4.14.0', isasync : True, params : [{name : 'hostid', description : 'If quickrestore is true, which host to start the VM on; otherwise, ignored. Currently this parameter is only supported by the KBOSS provider.', type : 'uuid', length : 255, required : False, since : '4.23.0', related : ''}, {name : 'quickrestore', description : 'Whether to use the quick restore process or not. Currently this parameter is only supported by the KBOSS provider.', type : 'boolean', length : 255, required : False, since : '4.23.0'}, {name : 'backupid', description : 'ID of the Instance backup', type : 'uuid', length : 255, required : True, related : ''}, {name : 'volumeid', description : 'ID of the volume backed up', type : 'string', length : 255, required : True}, {name : 'virtualmachineid', description : 'ID of the Instance where to attach the restored volume', type : 'uuid', length : 255, required : True, related : 'scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,importVm'}], response : [{}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'removeNetworkPermissions', description : 'Removes Network permissions.', since : '4.17.0', isasync : False, params : [{name : 'networkid', description : 'The Network ID', type : 'uuid', length : 255, required : True, related : 'createNetwork,updateNetwork,listNetworks'}, {name : 'accountids', description : 'A comma delimited list of account IDs within owner\'s domain. If specified, "op" parameter has to be passed in.', type : 'list', length : 255, required : False, related : 'listAccounts'}, {name : 'projectids', description : 'A comma delimited list of projects within owner\'s domain. If specified, "op" parameter has to be passed in.', type : 'list', length : 255, required : False, related : ''}, {name : 'accounts', description : 'A comma delimited list of Accounts within owner\'s domain. If specified, "op" parameter has to be passed in.', type : 'list', length : 255, required : False}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteBackup', description : 'Delete Instance backup', since : '4.14.0', isasync : True, params : [{name : 'id', description : 'ID of the Instance backup', type : 'uuid', length : 255, required : True, related : ''}, {name : 'forced', description : 'Force the deletion of backup which removes the entire backup chain but keep Instance in Backup Offering', type : 'boolean', length : 255, required : False, since : '4.18.0.0'}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'deleteProjectRolePermission', description : 'Deletes a project role permission in the project', since : '4.15.0', isasync : False, params : [{name : 'projectid', description : 'ID of the project where the project role permission is to be deleted', type : 'uuid', length : 255, required : True, related : ''}, {name : 'id', description : 'ID of the project role permission to be deleted', type : 'uuid', length : 255, required : True, related : ''}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], httprequesttype : 'POST'}, {name : 'updateVnfTemplate', description : 'Updates a template to VNF template or attributes of a VNF template.', since : '4.19.0', isasync : False, related : 'listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate', params : [{name : 'format', description : 'The format for the image', type : 'string', length : 255, required : False}, {name : 'requireshvm', description : 'True if the Template requires HVM, false otherwise; available only for updateTemplate API', type : 'boolean', length : 255, required : False}, {name : 'cleanupvnfnics', description : 'optional boolean field, which indicates if VNF nics will be cleaned up or not', type : 'boolean', length : 255, required : False}, {name : 'sshkeyenabled', description : 'True if the Template supports the SSHkey upload feature; default is false', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'The name of the image file', type : 'string', length : 251, required : False}, {name : 'id', description : 'The ID of the image file', type : 'uuid', length : 255, required : True, related : 'listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'isdynamicallyscalable', description : 'True if Template/ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean', length : 255, required : False}, {name : 'forcks', description : 'indicates that the template can be used for deployment of CKS clusters', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'forceupdateostype', description : 'Force OS type update. Warning: Updating OS type will update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.', type : 'boolean', length : 255, required : False, since : '4.21'}, {name : 'sortkey', description : 'Sort key of the Template, integer', type : 'integer', length : 255, required : False}, {name : 'vnfdetails', description : 'VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0', type : 'map', length : 255, required : False}, {name : 'bootable', description : 'True if image is bootable, false otherwise; available only for updateIso API', type : 'boolean', length : 255, required : False}, {name : 'cleanupdetails', description : 'Optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)', type : 'boolean', length : 255, required : False}, {name : 'templatetag', description : 'the tag for this template.', type : 'string', length : 255, required : False, since : '4.20.0'}, {name : 'cleanupvnfdetails', description : 'optional boolean field, which indicates if VNF details will be cleaned up or not', type : 'boolean', length : 255, required : False}, {name : 'ostypeid', description : 'The ID of the OS type that best represents the OS of this image.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'templatetype', description : 'The type of the Template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).', type : 'string', length : 255, required : False}, {name : 'displaytext', description : 'The display text of the image', type : 'string', length : 4096, required : False}, {name : 'isrouting', description : 'True if the Template type is routing i.e., if Template is used to deploy router', type : 'boolean', length : 255, required : False}, {name : 'arch', description : 'the CPU arch of the template/ISO. Valid options are: x86_64, aarch64, s390x', type : 'string', length : 255, required : False, since : '4.20'}, {name : 'details', description : 'Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61', type : 'map', length : 255, required : False}, {name : 'vnfnics', description : 'VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue.  Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC', type : 'map', length : 255, required : False}, {name : 'passwordenabled', description : 'True if the image supports the password reset feature; default is false', type : 'boolean', length : 255, required : False}], response : [{name : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {name : 'passwordenabled', description : 'True if the reset password feature is enabled, false otherwise', type : 'boolean'}, {name : 'extensionname', description : 'The name of extension linked to this template', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'isextractable', description : 'True if the Template is extractable, false otherwise', type : 'boolean'}, {name : 'format', description : 'The format of the Template.', type : 'imageformat'}, {name : 'userdataparams', description : 'List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata', type : 'string'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean'}, {}, {name : 'zonename', description : 'The name of the zone for this Template', type : 'string'}, {name : 'parenttemplateid', description : 'If Datadisk Template, then id of the root disk Template this Template belongs to', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'isready', description : 'True if the Template is ready to be deployed from, false otherwise.', type : 'boolean'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}, {name : 'sourcetemplateid', description : 'The Template ID of the parent Template if present', type : 'string'}, {name : 'url', description : 'The URL which the Template/ISO is registered from', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'requireshvm', description : 'True if Template requires HVM enabled, false otherwise', type : 'boolean'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'crossZones', description : 'True if the Template is managed across all Zones, false otherwise', type : 'boolean'}, {name : 'sshkeyenabled', description : 'True if Template is sshkey enabled, false otherwise', type : 'boolean'}, {name : 'arch', description : 'CPU Arch of the template', type : 'string'}, {name : 'account', description : 'The Account name to which the Template belongs', type : 'string'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {name : 'accountid', description : 'The Account id to which the Template belongs', type : 'string'}, {name : 'hostname', description : 'The name of the secondary storage host for the Template', type : 'string'}, {name : 'ostypeid', description : 'The ID of the OS type for this Template.', type : 'string'}, {name : 'size', description : 'The size of the Template', type : 'long'}, {name : 'userdataname', description : 'The name of userdata linked to this Template', type : 'string'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', type : 'string'}, {name : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'domain', description : 'The name of the domain to which the Template belongs', type : 'string'}, {name : 'deployasis', description : 'VMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.', type : 'boolean'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'hostid', description : 'The ID of the secondary storage host for the Template', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'status', description : 'The status of the Template', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean'}, {name : 'checksum', description : 'Checksum of the Template', type : 'string'}, {name : 'name', description : 'The Template name', type : 'string'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {name : 'project', description : 'The project name of the Template', type : 'string'}, {name : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'userdataid', description : 'The id of userdata linked to this Template', type : 'string'}, {name : 'bits', description : 'The processor bit size', type : 'int'}, {name : 'extensionid', description : 'The ID of extension linked to this template', type : 'string'}, {name : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {name : 'displaytext', description : 'The Template display text', type : 'string'}, {name : 'ispublic', description : 'True if this Template is a public Template, false otherwise', type : 'boolean'}, {name : 'templatetype', description : 'The type of the Template', type : 'string'}, {}, {}, {name : 'directdownload', description : 'KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage', type : 'boolean'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}, {name : 'id', description : 'The Template ID', type : 'string'}, {name : 'domainid', description : 'The ID of the domain to which the Template belongs', type : 'string'}, {name : 'removed', description : 'The date this Template was removed', type : 'date'}, {name : 'templatetag', description : 'The tag of this Template', type : 'string'}], httprequesttype : 'POST'}, {name : 'listUserTwoFactorAuthenticatorProviders', description : 'Lists user two factor authenticator providers', since : '4.18.0', isasync : False, related : '', params : [{name : 'name', description : 'List user two factor authenticator provider by name', type : 'string', length : 255, required : False}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'The user two factor authenticator provider name', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'description', description : 'The description of the user two factor authenticator provider', type : 'string'}], httprequesttype : 'GET'}, {name : 'importVm', description : 'Import virtual machine from a unmanaged host into CloudStack', since : '4.19.0', isasync : True, related : 'scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances', params : [{name : 'diskpath', description : 'path of the disk image. It is the file name on file based storage pools (NFS, Local, SharedMountPoint), and the image name on RBD storage pools', type : 'string', length : 255, required : False}, {name : 'hostname', description : 'The host name of the Instance', type : 'string', length : 255, required : False}, {name : 'templateid', description : 'The ID of the Template for the Instance', type : 'uuid', length : 255, required : False, related : 'listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate'}, {name : 'clustername', description : '(only for importing VMs from VMware to KVM) Name of VMware cluster.', type : 'string', length : 255, required : False}, {name : 'hostid', description : 'Host where local disk is located', type : 'uuid', length : 255, required : False, related : ''}, {name : 'storageid', description : 'Shared storage pool where disk is located', type : 'uuid', length : 255, required : False, related : ''}, {name : 'host', description : 'the host name or IP address', type : 'string', length : 255, required : False}, {name : 'nicnetworklist', description : 'VM NIC to network id mapping using keys NIC and network', type : 'map', length : 255, required : False}, {name : 'importinstancehostid', description : '(only for importing VMs from VMware to KVM) optional - the host to import the converted instance from VMware to KVM.', type : 'uuid', length : 255, required : False, since : '4.19.2', related : ''}, {name : 'datadiskofferinglist', description : 'Datadisk Template to disk-offering mapping using keys disk and diskOffering', type : 'map', length : 255, required : False}, {name : 'domainid', description : 'Import Instance to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'osid', description : '(only for importing VMs from VMware to KVM) optional - the ID of the guest OS for the imported VM.', type : 'uuid', length : 255, required : False, since : '4.22.1', related : ''}, {name : 'hostip', description : '(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'datacentername', description : '(only for importing VMs from VMware to KVM) Name of VMware datacenter.', type : 'string', length : 255, required : False}, {name : 'hypervisor', description : 'hypervisor type of the host', type : 'string', length : 255, required : True}, {name : 'convertinstancepoolid', description : '(only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'forcemstoimportvmfiles', description : '(only for importing VMs from VMware to KVM) optional - if true, forces MS to export OVF from VMware to temporary storage, else uses KVM Host if ovftool is available, falls back to MS if not.', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'The name of the Instance as it is known to the hypervisor', type : 'string', length : 255, required : True}, {name : 'networkid', description : 'the network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,updateNetwork,listNetworks'}, {name : 'password', description : 'the password for the host', type : 'string', length : 255, required : False}, {name : 'convertinstancehostid', description : '(only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v conversion from VMware to KVM.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'username', description : 'the username for the host', type : 'string', length : 255, required : False}, {name : 'extraparams', description : '(only for importing VMs from VMware to KVM) optional - extra parameters to be passed on the virt-v2v command, if allowed by the administrator', type : 'string', length : 255, required : False, since : '4.22'}, {name : 'existingvcenterid', description : '(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter', type : 'uuid', length : 255, required : False, related : ''}, {name : 'projectid', description : 'Import Instance for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'nicipaddresslist', description : 'VM NIC to ip address mapping using keys NIC, ip4Address', type : 'map', length : 255, required : False}, {name : 'account', description : 'An optional account for the Instance. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'serviceofferingid', description : 'The service offering for the Instance', type : 'uuid', length : 255, required : True, related : 'updateServiceOffering'}, {name : 'importsource', description : 'Source location for Import', type : 'string', length : 255, required : True}, {name : 'usevddk', description : '(only for importing VMs from VMware to KVM) optional - if true, uses VDDK on the KVM conversion host for converting the VM. This parameter is mutually exclusive with forcemstoimportvmfiles.', type : 'boolean', length : 255, required : False, since : '4.22.1'}, {name : 'displayname', description : 'The display name of the Instance', type : 'string', length : 255, required : False}, {name : 'vcenter', description : '(only for importing VMs from VMware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.', type : 'string', length : 255, required : False}, {name : 'forced', description : "Instance is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", type : 'boolean', length : 255, required : False}, {name : 'temppath', description : 'Temp Path on external host for disk image copy', type : 'string', length : 255, required : False}, {name : 'migrateallowed', description : 'Instance and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool', type : 'boolean', length : 255, required : False}, {name : 'forceconverttopool', description : '(only for importing VMs from VMware to KVM) optional - if true, forces virt-v2v conversions to write directly on the provided storage pool (avoid using temporary conversion pool).', type : 'boolean', length : 255, required : False, since : '4.22'}, {name : 'clusterid', description : 'The cluster ID', type : 'uuid', length : 255, required : True, related : ''}, {name : 'details', description : 'Used to specify the custom parameters.', type : 'map', length : 255, required : False}], response : [{name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}]}, {}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}]}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}]}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}]}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {}, {}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}]}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}]}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}]}]}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}]}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}], httprequesttype : 'POST'}]
2026-10-09 17:14:09,997 - DEBUG - Payload: {'command': 'listAccounts', 'response': 'json', 'apiKey': 'YGafIaYkUwKooQFjAjiwBU04J8aingJtZf2EaKJU6Xj1Cc787jyQgRhOVatBx7CfickiHZvktjYKFlcroO_cgQ', 'signature': b'3sja5AYcylWoZxJtx76VlEAVdD4='}
2026-10-09 17:14:09,998 - DEBUG - ========Sending GET Cmd : listAccounts=======
2026-10-09 17:14:10,068 - DEBUG - Response : [{id : 'f6ffb457-2990-4712-8035-6fb9a43c9976', name : 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', accounttype : 0, roleid : 'a7a204ab-fc30-405c-ab9e-577550a4ab20', roletype : 'User', rolename : 'MarvinFake Role me59if1hn5', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:01+0000', user : [{id : '60eeff3a-166b-43cf-8c57-6300acb8313e', username : 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:02+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls-9CZNMG', accounttype : 0, usersource : 'native', roleid : 'a7a204ab-fc30-405c-ab9e-577550a4ab20', roletype : 'User', rolename : 'MarvinFake Role me59if1hn5', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', apikey : 'YGafIaYkUwKooQFjAjiwBU04J8aingJtZf2EaKJU6Xj1Cc787jyQgRhOVatBx7CfickiHZvktjYKFlcroO_cgQ', accountid : 'f6ffb457-2990-4712-8035-6fb9a43c9976', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : []}]
2026-10-09 17:14:10,068 - DEBUG - Payload: {'command': 'listHosts', 'response': 'json', 'apiKey': 'YGafIaYkUwKooQFjAjiwBU04J8aingJtZf2EaKJU6Xj1Cc787jyQgRhOVatBx7CfickiHZvktjYKFlcroO_cgQ', 'signature': b'jtmg7takeqdsx6/JEK+IQVH4vjE='}
2026-10-09 17:14:10,069 - DEBUG - ========Sending GET Cmd : listHosts=======
2026-10-09 17:14:10,082 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listHosts] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls-9CZNMG.\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listHosts] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls-9CZNMG.
2026-10-09 17:14:10,082 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.listHosts.listHostsCmd object at 0x7f22470bdf70> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listHosts] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls-9CZNMG.\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listHosts] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls-9CZNMG.
2026-10-09 17:14:10,082 - DEBUG - Payload: {'command': 'listZones', 'response': 'json', 'apiKey': 'YGafIaYkUwKooQFjAjiwBU04J8aingJtZf2EaKJU6Xj1Cc787jyQgRhOVatBx7CfickiHZvktjYKFlcroO_cgQ', 'signature': b'/ecy9HotVFC6WXh/Ky1YHSMgMpA='}
2026-10-09 17:14:10,082 - DEBUG - ========Sending GET Cmd : listZones=======
2026-10-09 17:14:10,094 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listZones] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls-9CZNMG.\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listZones] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls-9CZNMG.
2026-10-09 17:14:10,094 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.listZones.listZonesCmd object at 0x7f2247071ee0> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listZones] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls-9CZNMG.\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listZones] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls-9CZNMG.
2026-10-09 17:14:10,095 - DEBUG - Payload: {'id': 'f6ffb457-2990-4712-8035-6fb9a43c9976', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'J/KZf/XFK/rqvDvpfZr/qDWckes='}
2026-10-09 17:14:10,095 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:10,134 - DEBUG - === Jobid: 5d4fb38d-2a9e-413f-a353-05137c6e5429 Started ===
2026-10-09 17:14:10,134 - DEBUG - Payload: {'jobid': '5d4fb38d-2a9e-413f-a353-05137c6e5429', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'p5dLx19QF8lhRymnQsO0Ptq7XgA='}
2026-10-09 17:14:10,134 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:10,182 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'f6ffb457-2990-4712-8035-6fb9a43c9976', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:10+0000', jobid : '5d4fb38d-2a9e-413f-a353-05137c6e5429', jobstatus : 0}
2026-10-09 17:14:11,184 - DEBUG - === JobId:5d4fb38d-2a9e-413f-a353-05137c6e5429 is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:11,184 - DEBUG - Payload: {'jobid': '5d4fb38d-2a9e-413f-a353-05137c6e5429', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'p5dLx19QF8lhRymnQsO0Ptq7XgA='}
2026-10-09 17:14:11,184 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:11,216 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'f6ffb457-2990-4712-8035-6fb9a43c9976', created : '2026-10-09T17:14:10+0000', completed : '2026-10-09T17:14:10+0000', jobid : '5d4fb38d-2a9e-413f-a353-05137c6e5429', jobstatus : 1}
2026-10-09 17:14:11,216 - DEBUG - ===Jobid:5d4fb38d-2a9e-413f-a353-05137c6e5429 ; StartTime:Fri Oct  9 17:14:10 2026 ; EndTime:Fri Oct  9 17:14:11 2026 ; TotalTime:-1===
2026-10-09 17:14:11,216 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'f6ffb457-2990-4712-8035-6fb9a43c9976', created : '2026-10-09T17:14:10+0000', completed : '2026-10-09T17:14:10+0000', jobid : '5d4fb38d-2a9e-413f-a353-05137c6e5429', jobstatus : 1}
2026-10-09 17:14:11,217 - DEBUG - Payload: {'id': '7198a342-cffb-4424-9fbb-99537aee374e', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'wZJQ95UuTKj7qoGSITXWIqK13eo='}
2026-10-09 17:14:11,217 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:11,254 - DEBUG - Response : {success : True}
2026-10-09 17:14:11,255 - DEBUG - Payload: {'id': 'a7a204ab-fc30-405c-ab9e-577550a4ab20', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'YdKWAOCy92ISZESRoIeNOzPViEE='}
2026-10-09 17:14:11,255 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:11,293 - DEBUG - Response : {success : True}
2026-10-09 17:14:11,294 - DEBUG - TestCaseName: test_role_account_acls; Time Taken: 10 Seconds; StartTime: Fri Oct  9 17:14:00 2026; EndTime: Fri Oct  9 17:14:11 2026; Result: SUCCESS
2026-10-09 17:14:11,294 - DEBUG - ::::::::::::STARTED : TC: test_role_account_acls_multiple_mgmt_servers :::::::::::
2026-10-09 17:14:11,295 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:11,295 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:11,339 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:11,340 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role o05v0k3wo4', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'7WmS6i3pEN1geoKkSXmDq37NTJI='}
2026-10-09 17:14:11,340 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:11,373 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'aff02351-4f31-469d-9536-5ee719f01da8', name : 'MarvinFake Role o05v0k3wo4', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:11,374 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'aff02351-4f31-469d-9536-5ee719f01da8', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'No0wEHdKpuk7PyDxRW38VSxjU3I='}
2026-10-09 17:14:11,374 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:11,421 - DEBUG - Response : {id : '3e875418-8ade-4997-abe8-011d9dd22e5a', roleid : 'aff02351-4f31-469d-9536-5ee719f01da8', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:11,422 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': 'aff02351-4f31-469d-9536-5ee719f01da8', 'username': 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'DfPnY6xQ3a6jaPikN437WZGAq/E='}
2026-10-09 17:14:11,422 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:14:12,805 - DEBUG - Response : {id : '1b6669e6-3534-482f-acbd-79c0f97f629c', name : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', accounttype : 0, roleid : 'aff02351-4f31-469d-9536-5ee719f01da8', roletype : 'User', rolename : 'MarvinFake Role o05v0k3wo4', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:12+0000', user : [{id : 'c8160519-f991-46c9-b98a-d71845263e59', username : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:12+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', accounttype : 0, usersource : 'native', roleid : 'aff02351-4f31-469d-9536-5ee719f01da8', roletype : 'User', rolename : 'MarvinFake Role o05v0k3wo4', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '1b6669e6-3534-482f-acbd-79c0f97f629c', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:14:12,805 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:14:12,805 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:14:12,836 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:14:17,985 - DEBUG - Payload: {'name': 'ROOT', 'command': 'listDomains', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'FUkLFPJq0p6AOaVYSkY//WIQFBk='}
2026-10-09 17:14:17,985 - DEBUG - ========Sending GET Cmd : listDomains=======
2026-10-09 17:14:18,016 - DEBUG - Response : [{id : '403e1dfc-c3f0-11f1-975d-1e002100023e', name : 'ROOT', level : 0, haschild : False, path : 'ROOT', state : 'Active', vmlimit : 'Unlimited', vmtotal : 0, vmavailable : 'Unlimited', iplimit : 'Unlimited', iptotal : 0, ipavailable : 'Unlimited', volumelimit : 'Unlimited', volumetotal : 2, volumeavailable : 'Unlimited', snapshotlimit : 'Unlimited', snapshottotal : 0, snapshotavailable : 'Unlimited', backuplimit : 'Unlimited', backuptotal : 0, backupavailable : 'Unlimited', backupstoragelimit : 'Unlimited', backupstoragetotal : 0, backupstorageavailable : 'Unlimited', templatelimit : 'Unlimited', templatetotal : 13, templateavailable : 'Unlimited', projectlimit : 'Unlimited', projecttotal : 0, projectavailable : 'Unlimited', networklimit : 'Unlimited', networktotal : 0, networkavailable : 'Unlimited', vpclimit : 'Unlimited', vpctotal : 0, vpcavailable : 'Unlimited', cpulimit : 'Unlimited', cputotal : 0, cpuavailable : 'Unlimited', memorylimit : 'Unlimited', memorytotal : 0, memoryavailable : 'Unlimited', gpulimit : 'Unlimited', gputotal : 0, gpuavailable : 'Unlimited', primarystoragelimit : 'Unlimited', primarystoragetotal : 9, primarystorageavailable : 'Unlimited', secondarystoragelimit : 'Unlimited', secondarystoragetotal : 13.067401, secondarystorageavailable : 'Unlimited', bucketlimit : 'Unlimited', buckettotal : 0, bucketavailable : 'Unlimited', objectstoragelimit : 'Unlimited', objectstoragetotal : 0, objectstorageavailable : 'Unlimited', hasannotations : False}]
2026-10-09 17:14:18,016 - DEBUG - Payload: {'listall': True, 'name': 'ROOT', 'command': 'listDomains', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'MTo4M/OsRVaY9H/KZqvgm9hNmEQ='}
2026-10-09 17:14:18,016 - DEBUG - ========Sending GET Cmd : listDomains=======
2026-10-09 17:14:18,046 - DEBUG - Response : [{id : '403e1dfc-c3f0-11f1-975d-1e002100023e', name : 'ROOT', level : 0, haschild : False, path : 'ROOT', state : 'Active', vmlimit : 'Unlimited', vmtotal : 0, vmavailable : 'Unlimited', iplimit : 'Unlimited', iptotal : 0, ipavailable : 'Unlimited', volumelimit : 'Unlimited', volumetotal : 2, volumeavailable : 'Unlimited', snapshotlimit : 'Unlimited', snapshottotal : 0, snapshotavailable : 'Unlimited', backuplimit : 'Unlimited', backuptotal : 0, backupavailable : 'Unlimited', backupstoragelimit : 'Unlimited', backupstoragetotal : 0, backupstorageavailable : 'Unlimited', templatelimit : 'Unlimited', templatetotal : 13, templateavailable : 'Unlimited', projectlimit : 'Unlimited', projecttotal : 0, projectavailable : 'Unlimited', networklimit : 'Unlimited', networktotal : 0, networkavailable : 'Unlimited', vpclimit : 'Unlimited', vpctotal : 0, vpcavailable : 'Unlimited', cpulimit : 'Unlimited', cputotal : 0, cpuavailable : 'Unlimited', memorylimit : 'Unlimited', memorytotal : 0, memoryavailable : 'Unlimited', gpulimit : 'Unlimited', gputotal : 0, gpuavailable : 'Unlimited', primarystoragelimit : 'Unlimited', primarystoragetotal : 9, primarystorageavailable : 'Unlimited', secondarystoragelimit : 'Unlimited', secondarystoragetotal : 13.067401, secondarystorageavailable : 'Unlimited', bucketlimit : 'Unlimited', buckettotal : 0, bucketavailable : 'Unlimited', objectstoragelimit : 'Unlimited', objectstoragetotal : 0, objectstorageavailable : 'Unlimited', hasannotations : False}]
2026-10-09 17:14:18,047 - DEBUG - Payload: {'domainid': '403e1dfc-c3f0-11f1-975d-1e002100023e', 'listall': True, 'name': 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', 'command': 'listAccounts', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'LGwrnJJjIJpUZ5xTY7dym4TH+yM='}
2026-10-09 17:14:18,047 - DEBUG - ========Sending GET Cmd : listAccounts=======
2026-10-09 17:14:18,096 - DEBUG - Response : [{id : '1b6669e6-3534-482f-acbd-79c0f97f629c', name : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', accounttype : 0, roleid : 'aff02351-4f31-469d-9536-5ee719f01da8', roletype : 'User', rolename : 'MarvinFake Role o05v0k3wo4', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:12+0000', user : [{id : 'c8160519-f991-46c9-b98a-d71845263e59', username : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:12+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', accounttype : 0, usersource : 'native', roleid : 'aff02351-4f31-469d-9536-5ee719f01da8', roletype : 'User', rolename : 'MarvinFake Role o05v0k3wo4', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '1b6669e6-3534-482f-acbd-79c0f97f629c', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}]
2026-10-09 17:14:18,097 - DEBUG - Payload: {'domainid': '403e1dfc-c3f0-11f1-975d-1e002100023e', 'listall': True, 'username': 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', 'command': 'listUsers', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'B0m8ierQc9lvcblWb7C3hGd0nx4='}
2026-10-09 17:14:18,097 - DEBUG - ========Sending GET Cmd : listUsers=======
2026-10-09 17:14:18,148 - DEBUG - Response : [{id : 'c8160519-f991-46c9-b98a-d71845263e59', username : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:12+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', accounttype : 0, usersource : 'native', roleid : 'aff02351-4f31-469d-9536-5ee719f01da8', roletype : 'User', rolename : 'MarvinFake Role o05v0k3wo4', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '1b6669e6-3534-482f-acbd-79c0f97f629c', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False, apikeyaccess : 'INHERIT'}]
2026-10-09 17:14:18,149 - DEBUG - Payload: {'id': 'c8160519-f991-46c9-b98a-d71845263e59', 'command': 'getUserKeys', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'owXaIQhVhBz1L2G9LDp1OMhBlvA='}
2026-10-09 17:14:18,149 - DEBUG - ========Sending GET Cmd : getUserKeys=======
2026-10-09 17:14:18,171 - DEBUG - Response : {apikeyaccess : True}
2026-10-09 17:14:18,172 - ERROR - __createApiClient: API Client Creation Failed
2026-10-09 17:14:18,172 - DEBUG - Payload: {'id': 'c8160519-f991-46c9-b98a-d71845263e59', 'name': 'keypair-c8160519-f991-46c9-b98a-d71845263e59', 'command': 'registerUserKeys', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Xqjfc1pwI+tN0mmkfM4vFrmNP7w='}
2026-10-09 17:14:18,172 - DEBUG - ========Sending GET Cmd : registerUserKeys=======
2026-10-09 17:14:19,688 - DEBUG - Response : {name : 'keypair-c8160519-f991-46c9-b98a-d71845263e59', apikey : 'nffSzKgy7YUikAIJ3wkVODRposyx15FHLgJHmM8WCO3eMIDE-X9kkcQWkoQ9smtXEzrF1MyhjKYJ-kaL6DRmSQ', secretkey : 'elrYiCJvtfTY5S_WBJL4NHgObal280aIkoscorIXEsBd99laRf0DX3LYe8IOcWDLJNpJb328_j7OERrx9pIIMg', userid : 'c8160519-f991-46c9-b98a-d71845263e59', username : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', id : '03cc4c48-69ce-4d1b-bfe4-3e5f7baf5696', created : '2026-10-09T17:14:19+0000', accounttype : 'NORMAL', accountid : '1b6669e6-3534-482f-acbd-79c0f97f629c', accountname : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', roleid : 'aff02351-4f31-469d-9536-5ee719f01da8', roletype : 'User', rolename : 'MarvinFake Role o05v0k3wo4', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', state : 'ENABLED'}
2026-10-09 17:14:19,688 - DEBUG - Payload: {'id': 'c8160519-f991-46c9-b98a-d71845263e59', 'command': 'getUserKeys', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'owXaIQhVhBz1L2G9LDp1OMhBlvA='}
2026-10-09 17:14:19,688 - DEBUG - ========Sending GET Cmd : getUserKeys=======
2026-10-09 17:14:19,907 - DEBUG - Response : {apikey : 'nffSzKgy7YUikAIJ3wkVODRposyx15FHLgJHmM8WCO3eMIDE-X9kkcQWkoQ9smtXEzrF1MyhjKYJ-kaL6DRmSQ', secretkey : 'elrYiCJvtfTY5S_WBJL4NHgObal280aIkoscorIXEsBd99laRf0DX3LYe8IOcWDLJNpJb328_j7OERrx9pIIMg', apikeyaccess : True}
2026-10-09 17:14:19,908 - DEBUG - Payload: {'command': 'listApis', 'response': 'json', 'apiKey': 'nffSzKgy7YUikAIJ3wkVODRposyx15FHLgJHmM8WCO3eMIDE-X9kkcQWkoQ9smtXEzrF1MyhjKYJ-kaL6DRmSQ', 'signature': b'pt2w+oIKiMZMdTWj3Z99zEw2Zu0='}
2026-10-09 17:14:19,908 - DEBUG - ========Sending GET Cmd : listApis=======
2026-10-09 17:14:20,318 - DEBUG - Response : [{name : 'deleteAutoScaleVmProfile', description : 'Deletes a autoscale Instance profile.', isasync : True, params : [{name : 'id', description : 'The ID of the autoscale profile', type : 'uuid', length : 255, required : True, related : 'createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'deleteKMSKey', description : 'Deletes a KMS key (only if not in use)', since : '4.23.0', isasync : True, params : [{name : 'id', description : 'The UUID of the KMS key to delete', type : 'uuid', length : 255, required : True, related : 'listKMSKeys,createKMSKey,updateKMSKey'}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'rebootSystemVm', description : 'Reboots a system VM.', isasync : True, related : 'destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm', params : [{name : 'id', description : 'The ID of the System VM', type : 'uuid', length : 255, required : True, related : 'destroySystemVm,listSystemVms,migrateSystemVm,rebootSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm'}, {name : 'forced', description : 'Force reboot the System VM (System VM is Stopped and then Started)', type : 'boolean', length : 255, required : False, since : '4.16.0'}], response : [{name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}], httprequesttype : 'POST'}, {name : 'removeNodesFromKubernetesCluster', description : 'Removes external nodes from a CKS cluster. ', since : '4.21.0', isasync : True, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'id', description : 'the ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster,removeNodesFromKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {name : 'nodeids', description : 'comma separated list of node (physical or virtual machines) IDs that need to beremoved from the Kubernetes cluster (CKS)', type : 'list', length : 255, required : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}], response : [{name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}], httprequesttype : 'POST'}, {name : 'listOauthProvider', description : 'List OAuth providers registered', since : '4.19.0', isasync : False, related : 'verifyOAuthCodeAndGetUser,updateOauthProvider', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'provider', description : 'Name of the provider', type : 'string', length : 255, required : False}, {name : 'id', description : 'the ID of the OAuth provider', type : 'uuid', length : 255, required : False, related : 'listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'domainid', description : 'Domain ID to list OAuth providers for a specific domain. Use -1 for global providers only.', type : 'uuid', length : 255, required : False, since : '4.23.0', related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'domain', description : 'Domain path for domain-specific OAuth provider lookup. Ignored when Domain ID is passed.', type : 'string', length : 255, required : False, since : '4.23.0'}], response : [{name : 'id', description : 'ID of the provider', type : 'string'}, {name : 'redirecturi', description : 'Redirect URI registered in the OAuth provider', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'clientid', description : 'Client ID registered in the OAuth provider', type : 'string'}, {name : 'authorizeurl', description : 'Authorize URL registered in the OAuth provider', type : 'string'}, {}, {name : 'tokenurl', description : 'Token URL registered in the OAuth provider', type : 'string'}, {name : 'domain', description : 'name of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'provider', description : 'Name of the provider', type : 'string'}, {name : 'domainpath', description : 'path of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'enabled', description : 'Whether the OAuth provider is enabled or not', type : 'boolean'}, {}, {name : 'domainid', description : 'UUID of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'secretkey', description : 'Secret key registered in the OAuth provider', type : 'string'}, {name : 'name', description : 'Name of the provider', type : 'string'}, {name : 'description', description : 'Description of the provider registered', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'updateSharedFileSystem', description : 'Update a Shared FileSystem', since : '4.20.0', isasync : False, related : 'createSharedFileSystem,listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering', params : [{name : 'description', description : 'the description for the shared filesystem.', type : 'string', length : 255, required : False}, {name : 'name', description : 'the name of the shared filesystem.', type : 'string', length : 255, required : False}, {name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'createSharedFileSystem,listSharedFileSystems,updateSharedFileSystem,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}], response : [{name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}]}, {}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}], httprequesttype : 'POST'}, {name : 'destroySystemVm', description : 'Destroys a System VM.', isasync : True, related : 'listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm', params : [{name : 'id', description : 'The ID of the System VM', type : 'uuid', length : 255, required : True, related : 'destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm'}], response : [{name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}], httprequesttype : 'POST'}, {name : 'listASNumbers', description : 'List Autonomous Systems Numbers', since : '4.20.0', isasync : False, related : '', params : [{name : 'networkid', description : 'the network id', type : 'uuid', length : 255, required : False, related : 'createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'vpcid', description : 'the vpc id', type : 'uuid', length : 255, required : False, related : 'createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC'}, {name : 'domainid', description : 'domain id', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'asnrangeid', description : 'the AS Number range ID', type : 'uuid', length : 255, required : False, related : 'createASNRange,listASNRanges'}, {name : 'account', description : 'account name', type : 'string', length : 255, required : False, related : 'createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts'}, {name : 'asnumber', description : 'AS number', type : 'integer', length : 255, required : False, related : 'listASNumbers'}, {name : 'isallocated', description : 'to indicate if the AS number is allocated to any network', type : 'boolean', length : 255, required : False}], response : [{name : 'allocated', description : 'Allocated Date', type : 'date'}, {name : 'domain', description : 'the domain name', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'associatednetworkid', description : 'Network ID', type : 'string'}, {name : 'zonename', description : 'the zone name of the AS Number range', type : 'string'}, {name : 'associatednetworkname', description : 'Network Name', type : 'string'}, {name : 'asnumber', description : 'AS Number', type : 'long'}, {name : 'vpcname', description : 'VPC Name', type : 'string'}, {name : 'domainid', description : 'Domain ID', type : 'string'}, {name : 'id', description : 'ID of the AS Number', type : 'string'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'created', description : 'Created Date', type : 'date'}, {name : 'asnrangeid', description : 'AS Number ID', type : 'string'}, {name : 'allocationstate', description : 'Allocation state', type : 'string'}, {name : 'accountid', description : 'Account ID', type : 'string'}, {name : 'vpcid', description : 'VPC ID', type : 'string'}, {name : 'asnrange', description : 'AS Number Range', type : 'string'}, {}], httprequesttype : 'GET'}, {name : 'listUserData', description : 'List registered userdatas', since : '4.18', isasync : False, related : 'listCniConfiguration', params : [{name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'name', description : 'Userdata name to look for', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the Userdata', type : 'uuid', length : 255, required : False, related : 'listUserData,listCniConfiguration'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}], response : [{name : 'project', description : 'The project name of the User Data', type : 'string'}, {}, {name : 'accountid', description : 'The owner id of the User Data', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'params', description : 'List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in the User Data', type : 'string'}, {name : 'domain', description : 'The domain name of the User Data owner', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'id', description : 'ID of the User Data', type : 'string'}, {name : 'domainid', description : 'The domain id of the User Data owner', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'projectid', description : 'The project id of the User Data', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the User Data owner belongs', type : 'string'}, {name : 'account', description : 'The owner of the User Data', type : 'string'}, {name : 'name', description : 'Name of the User Data', type : 'string'}, {name : 'userdata', description : 'Base64 encoded User Data content', type : 'string'}], httprequesttype : 'GET'}, {name : 'scaleSystemVm', description : 'Scale the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect.', isasync : True, related : 'listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm', params : [{name : 'serviceofferingid', description : 'The service offering ID to apply to the system vm', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,cloneServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'details', description : 'Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value', type : 'map', length : 255, required : False}, {name : 'id', description : 'The ID of the system vm', type : 'uuid', length : 255, required : True, related : 'listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm'}], response : [{}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}], httprequesttype : 'POST'}, {name : 'verifyOAuthCodeAndGetUser', description : 'Verify the OAuth Code and fetch the corresponding user from provider', since : '4.19.0', isasync : False, related : 'updateOauthProvider', params : [{name : 'secretcode', description : 'Code that is provided by OAuth provider (Eg. google, github) after successful login', type : 'string', length : 255, required : False}, {name : 'provider', description : 'Name of the provider', type : 'string', length : 255, required : True}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'domain', description : 'Domain path for domain-specific OAuth provider lookup. Ignored when Domain ID is passed.', type : 'string', length : 255, required : False, since : '4.23.0'}, {name : 'domainid', description : 'Domain ID for domain-specific OAuth provider lookup. If not provided, uses global provider', type : 'uuid', length : 255, required : False, since : '4.23.0', related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}], response : [{name : 'domainpath', description : 'path of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'id', description : 'ID of the provider', type : 'string'}, {name : 'domainid', description : 'UUID of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'secretkey', description : 'Secret key registered in the OAuth provider', type : 'string'}, {}, {name : 'redirecturi', description : 'Redirect URI registered in the OAuth provider', type : 'string'}, {name : 'tokenurl', description : 'Token URL registered in the OAuth provider', type : 'string'}, {name : 'authorizeurl', description : 'Authorize URL registered in the OAuth provider', type : 'string'}, {name : 'domain', description : 'name of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'description', description : 'Description of the provider registered', type : 'string'}, {name : 'provider', description : 'Name of the provider', type : 'string'}, {name : 'clientid', description : 'Client ID registered in the OAuth provider', type : 'string'}, {name : 'name', description : 'Name of the provider', type : 'string'}, {name : 'enabled', description : 'Whether the OAuth provider is enabled or not', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], httprequesttype : 'GET'}, {name : 'createBackupSchedule', description : 'Creates a User-defined Instance backup schedule', since : '4.14.0', isasync : False, related : 'listBackupSchedule', params : [{name : 'virtualmachineid', description : 'ID of the Instance for which schedule is to be defined', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'isolated', description : 'Whether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.', type : 'boolean', length : 255, required : False, since : '4.23.0'}, {name : 'timezone', description : 'Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.', type : 'string', length : 255, required : True}, {name : 'maxbackups', description : 'The maximum number of backups to keep for a VM. If "0", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.', type : 'integer', length : 255, required : False, since : '4.21.0'}, {name : 'quiescevm', description : 'Quiesce the Instance before checkpointing the disks for backup. Applicable only to NAS and KBOSS backup providers. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'schedule', description : 'Custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28)', type : 'string', length : 255, required : True}, {name : 'intervaltype', description : 'Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY', type : 'string', length : 255, required : True}], response : [{name : 'quiescevm', description : 'quiesce the instance before checkpointing the disks for backup', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {name : 'schedule', description : 'The time the backup is scheduled to be taken.', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'maxbackups', description : 'maximum number of backups retained', type : 'integer'}, {name : 'id', description : 'ID of the backup schedule.', type : 'string'}, {name : 'isolated', description : 'Whether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.', type : 'boolean'}, {}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'timezone', description : 'The time zone of the backup schedule', type : 'string'}, {name : 'intervaltype', description : 'The interval type of the backup schedule', type : 'intervaltype'}, {}], httprequesttype : 'POST'}, {name : 'listKMSKeys', description : 'Lists KMS keys available to the caller', since : '4.23.0', isasync : False, related : 'createKMSKey,updateKMSKey', params : [{name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'enabled', description : 'Filter by enabled status', type : 'boolean', length : 255, required : False}, {name : 'hsmprofileid', description : 'Filter by HSM profile ID', type : 'uuid', length : 255, required : False, related : 'createHSMProfile,listHSMProfiles,updateHSMProfile'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'List KMS key by UUID', type : 'uuid', length : 255, required : False, related : 'listKMSKeys,createKMSKey,updateKMSKey'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'zoneid', description : 'Filter by zone ID', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}], response : [{name : 'domain', description : 'the domain name of the key', type : 'string'}, {name : 'created', description : 'the creation timestamp', type : 'date'}, {name : 'name', description : 'the name of the key', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'the UUID of the key', type : 'string'}, {name : 'project', description : 'the project name of the key', type : 'string'}, {name : 'enabled', description : 'whether the key is enabled', type : 'boolean'}, {name : 'description', description : 'the description of the key', type : 'string'}, {name : 'accountid', description : 'the account ID owning the key', type : 'string'}, {name : 'zoneid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'domainid', description : 'the domain ID of the key', type : 'string'}, {}, {name : 'domainpath', description : 'the domain path of the key', type : 'string'}, {name : 'hsmprofileid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'account', description : 'the account owning the key', type : 'string'}, {name : 'keybits', description : 'the key size in bits', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zonename', description : 'the zone name where the key is valid', type : 'string'}, {name : 'projectid', description : 'the project ID of the key', type : 'string'}, {}, {name : 'version', description : 'the key size in bits', type : 'integer'}, {name : 'keklabel', description : 'the provider-specific KEK label (admin only)', type : 'string'}, {name : 'algorithm', description : 'the encryption algorithm', type : 'string'}, {name : 'hsmprofile', description : 'the zone name where the key is valid', type : 'string'}], httprequesttype : 'GET'}, {name : 'cleanVMReservations', description : 'Cleanups Instance reservations in the database.', isasync : True, params : [], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'updateRoutingFirewallRule', description : 'Updates Routing firewall rule with specified ID', since : '4.20.0', isasync : True, related : 'createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules', params : [{name : 'id', description : 'the ID of the Routing firewall rule', type : 'uuid', length : 255, required : True, related : 'createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules'}, {name : 'customid', description : 'An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only', type : 'string', length : 255, required : False, since : '4.4'}, {name : 'fordisplay', description : 'an optional field, whether to the display the Routing firewall rule to the end user or not', type : 'boolean', length : 255, required : False}], response : [{name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {name : 'privateport', description : "The starting port of port forwarding rule's private port range", type : 'string'}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}, {name : 'privateendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {}, {name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {name : 'virtualmachinedisplayname', description : 'The Instance display name for the port forwarding rule', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'list', response : [{name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {name : 'state', description : 'The state of the rule', type : 'string'}, {}, {name : 'networkid', description : 'The ID of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'id', description : 'The ID of the port forwarding rule', type : 'string'}, {name : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', type : 'string'}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID for the port forwarding rule', type : 'string'}, {name : 'publicport', description : "The starting port of port forwarding rule's public port range", type : 'string'}, {name : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listObjectStoragePools', description : 'Lists object storage pools.', since : '4.19.0', isasync : False, related : 'addObjectStoragePool,updateObjectStoragePool', params : [{name : 'id', description : 'the ID of the storage pool', type : 'uuid', length : 255, required : False, related : 'addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool'}, {name : 'name', description : 'the name of the object store', type : 'string', length : 255, required : False}, {name : 'provider', description : 'the object store provider', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'url', description : 'the url of the object store', type : 'string'}, {}, {name : 'name', description : 'the name of the object store', type : 'string'}, {name : 'storageallocated', description : 'the allocated size of the object store', type : 'long'}, {name : 'storagetotal', description : 'the total size of the object store', type : 'long'}, {name : 'id', description : 'the ID of the object store', type : 'string'}, {name : 'storageused', description : 'the object store currently used size', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'providername', description : 'the provider name of the object store', type : 'string'}, {}], httprequesttype : 'GET'}, {name : 'removeVmwareDc', description : 'Remove a VMware datacenter from a zone.', isasync : False, params : [{name : 'zoneid', description : 'The id of Zone from which VMware datacenter has to be removed.', type : 'uuid', length : 255, required : True, related : 'createZone,updateZone,listZones,listZones'}], response : [{}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'runCustomAction', description : 'Run the custom action', since : '4.21.0', isasync : True, related : '', params : [{name : 'resourceid', description : 'ID of the instance', type : 'string', length : 255, required : True}, {name : 'customactionid', description : 'ID of the custom action', type : 'uuid', length : 255, required : True, related : 'addCustomAction,listCustomActions'}, {name : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : False}, {name : 'parameters', description : 'Parameters in key/value pairs using format parameters[i].keyname=keyvalue. Example: parameters[0].endpoint.url=urlvalue', type : 'map', length : 255, required : False}], response : [{name : 'id', description : 'ID of the action', type : 'string'}, {name : 'success', description : 'Whether custom action succeed or not', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'name', description : 'Name of the action', type : 'string'}, {name : 'result', description : 'Result of the action execution', type : 'map'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listDnsRecords', description : 'Lists DNS records from the external provider', since : '4.23.0', isasync : False, related : 'createDnsRecord', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'dnszoneid', description : 'ID of the DNS zone to list records from', type : 'uuid', length : 255, required : True, related : 'createDnsZone,listDnsZones,updateDnsZone'}], response : [{}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'contents', description : 'The contents of the record (IP address or target)', type : 'list'}, {name : 'name', description : 'The record name (e.g., www.example.com.)', type : 'string'}, {name : 'type', description : 'The record type (e.g., A, CNAME, TXT)', type : 'recordtype'}, {name : 'ttl', description : 'Time to live (TTL) in seconds', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'createBackup', description : 'Create Instance backup', since : '4.14.0', isasync : True, params : [{name : 'virtualmachineid', description : 'ID of the Instance', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'description', description : 'the description for the backup', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'quiescevm', description : 'Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS and KBOSS backup providers. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'isolated', description : 'Whether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.', type : 'boolean', length : 255, required : False, since : '4.23.0'}, {name : 'name', description : 'the name of the backup', type : 'string', length : 255, required : False, since : '4.21.0'}], response : [{}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'listIpv6FirewallRules', description : 'Lists all IPv6 firewall rules', isasync : False, related : 'createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules', params : [{name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'fordisplay', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'id', description : 'Lists IPv6 firewall rule with the specified ID', type : 'uuid', length : 255, required : False, related : 'createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'networkid', description : 'List IPV6 firewall rules by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'traffictype', description : 'List IPV6 firewall rules by traffic type - ingress or egress', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}], response : [{name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {name : 'state', description : 'The state of the rule', type : 'string'}, {name : 'networkid', description : 'The ID of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {}, {name : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}, {name : 'id', description : 'The ID of the port forwarding rule', type : 'string'}, {name : 'publicport', description : "The starting port of port forwarding rule's public port range", type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID for the port forwarding rule', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {name : 'privateendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {}, {name : 'privateport', description : "The starting port of port forwarding rule's private port range", type : 'string'}, {name : 'virtualmachinedisplayname', description : 'The Instance display name for the port forwarding rule', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'list', response : [{name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}], httprequesttype : 'GET'}, {name : 'stopSystemVm', description : 'Stops a system VM.', isasync : True, related : 'listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm', params : [{name : 'forced', description : 'Force stop the Instance (Instance is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the Instance is stopped and should be marked as such.', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The ID of the System VM', type : 'uuid', length : 255, required : True, related : 'listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm'}], response : [{name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}], httprequesttype : 'POST'}, {name : 'listVMSchedule', description : 'List Instance Schedules.', since : '4.19.0', isasync : False, related : 'createVMSchedule,updateVMSchedule', params : [{name : 'action', description : 'Action taken by schedule', type : 'string', length : 255, required : False}, {name : 'enabled', description : 'Filter by enabled status', type : 'boolean', length : 255, required : False}, {name : 'virtualmachineid', description : 'ID of the Instance for which schedule is to be defined', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'ID of Instance schedule', type : 'uuid', length : 255, required : False, related : 'createVMSchedule,listVMSchedule,updateVMSchedule'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'virtualmachineid', description : 'ID of Instance', type : 'string'}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'action', description : 'Action', type : 'action'}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'description', description : 'Description of Instance schedule', type : 'string'}, {}, {name : 'enabled', description : 'VM schedule is enabled', type : 'boolean'}, {name : 'schedule', description : 'Cron formatted Instance schedule', type : 'string'}, {}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'id', description : 'The ID of Instance schedule', type : 'string'}], httprequesttype : 'GET'}, {name : 'patchSystemVm', description : 'Attempts to live patch systemVMs - CPVM, SSVM ', since : '4.17.0', isasync : True, params : [{name : 'forced', description : 'If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'Patches System VM - CPVM/SSVM with the specified ID', type : 'uuid', length : 255, required : False, related : 'listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm'}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {}], httprequesttype : 'POST'}, {name : 'addNodesToKubernetesCluster', description : 'Add nodes as workers to an existing CKS cluster. ', since : '4.21.0', isasync : True, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'nodeids', description : 'comma separated list of (external) node (physical or virtual machines) IDs that need to beadded as worker nodes to an existing managed Kubernetes cluster (CKS)', type : 'list', length : 255, required : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'mountcksisoonvr', description : '(optional) Vmware only, uses the CKS cluster network VR to mount the CKS ISO', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'the ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, since : '4.21.0', related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {name : 'manualupgrade', description : '(optional) indicates if the node is marked for manual upgrade and excluded from the Kubernetes cluster upgrade operation', type : 'boolean', length : 255, required : False}], response : [{name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}], httprequesttype : 'POST'}, {name : 'listVolumesMetrics', description : 'Lists volume metrics', since : '4.9.3', isasync : False, related : '', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'isencrypted', description : 'list only volumes that are encrypted', type : 'boolean', length : 255, required : False, since : '4.19.1'}, {name : 'serviceofferingid', description : 'List volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored', type : 'uuid', length : 255, required : False, since : '4.19.1', related : 'createServiceOffering,cloneServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the disk volume', type : 'uuid', length : 255, required : False, related : 'attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}, {name : 'virtualmachineid', description : 'The ID of the Instance', type : 'uuid', length : 255, required : False, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'podid', description : 'The pod ID the disk volume belongs to', type : 'uuid', length : 255, required : False, related : 'createPod,listPods,updatePod,createManagementNetworkIpRange'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'listsystemvms', description : 'List system VMs; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.18'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'ids', description : 'The IDs of the volumes, mutually exclusive with id', type : 'list', length : 255, required : False, since : '4.9', related : 'attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}, {name : 'diskofferingid', description : 'List volumes by disk offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'createDiskOffering,cloneDiskOffering,updateDiskOffering,listDiskOfferings'}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", type : 'boolean', length : 255, required : False}, {name : 'storageid', description : 'The ID of the storage pool, available to ROOT admin only', type : 'string', length : 255, required : False, since : '4.3', related : 'cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}, {name : 'type', description : 'The type of disk volume', type : 'string', length : 255, required : False}, {name : 'clusterid', description : 'The cluster ID the disk volume belongs to', type : 'uuid', length : 255, required : False, related : 'addCluster,updateCluster'}, {name : 'name', description : 'The name of the disk volume', type : 'string', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'kmskeyid', description : 'List volumes by KMS Key', type : 'uuid', length : 255, required : False, since : '4.23', related : 'createKMSKey,updateKMSKey'}, {name : 'zoneid', description : 'The ID of the availability zone', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'hostid', description : 'List volumes on specified host', type : 'uuid', length : 255, required : False, related : 'addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost'}, {name : 'displayvolume', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'state', description : 'State of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.', type : 'string', length : 255, required : False}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}], response : [{name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'vmstate', description : 'State of the Instance', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'diskiopstotal', description : 'The total disk iops', type : 'long'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'sizegb', description : 'Disk size in GiB', type : 'string'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'deviceid', description : 'The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.', type : 'long'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {name : 'path', description : 'The path of the volume', type : 'string'}], httprequesttype : 'GET'}, {name : 'listDetailOptions', description : 'Lists all possible details and their options for a resource type such as an Instance or a Template', since : '4.13', isasync : False, related : '', params : [{name : 'resourceid', description : 'The UUID of the resource (optional)', type : 'string', length : 255, required : False}, {name : 'resourcetype', description : 'The resource type such as UserVm, Template etc.', type : 'string', length : 255, required : True}], response : [{}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'details', description : 'Map of all possible details and their possible list of values', type : 'map'}], httprequesttype : 'GET'}, {name : 'updateVmNicIp', description : 'Update the default IP of an Instance NIC', isasync : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm', params : [{name : 'ipaddress', description : 'Secondary IP Address', type : 'string', length : 255, required : False}, {name : 'nicid', description : 'The ID of the NIC to which you want to assign private IP', type : 'uuid', length : 255, required : True, related : 'updateVmNic,listNics'}], response : [{name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}]}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}]}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}]}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'description', description : 'The description of the security group', type : 'string'}]}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}]}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}, {name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'name', description : 'The name of the attached ISO', type : 'string'}]}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}], httprequesttype : 'POST'}, {name : 'startInternalLoadBalancerVM', description : 'Starts an existing Internal LB Instance.', isasync : True, related : 'destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx', params : [{name : 'id', description : 'The ID of the Internal LB Instance', type : 'uuid', length : 255, required : True, related : 'destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx'}], response : [{name : 'hostid', description : 'The host ID for the router', type : 'string'}, {name : 'hostname', description : 'The hostname for the router', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the router', type : 'string'}, {name : 'created', description : 'The date and time the router was created', type : 'date'}, {name : 'publicnetworkid', description : 'The ID of the corresponding public Network', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the router', type : 'string'}, {name : 'guestnetworkname', description : 'The name of the corresponding guest Network', type : 'string'}, {name : 'version', description : 'The version of Template', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the router', type : 'string'}, {name : 'podname', description : 'The Pod name for the router', type : 'string'}, {name : 'state', description : 'The state of the router', type : 'state'}, {name : 'guestipaddress', description : 'The guest IP address for the router', type : 'string'}, {}, {name : 'name', description : 'The name of the router', type : 'string'}, {name : 'role', description : 'Role of the domain router', type : 'string'}, {name : 'id', description : 'The ID of the router', type : 'string'}, {name : 'softwareversion', description : 'The version of the code / software in the router', type : 'string'}, {name : 'redundantstate', description : 'The state of redundant virtual router', type : 'string'}, {name : 'domain', description : 'The domain associated with the router', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'gateway', description : 'The gateway for the router', type : 'string'}, {name : 'podid', description : 'The Pod ID for the router', type : 'string'}, {name : 'guestmacaddress', description : 'The guest MAC address for the router', type : 'string'}, {name : 'requiresupgrade', description : 'True if the router Template requires upgrade', type : 'boolean'}, {name : 'arch', description : 'CPU arch of the router', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the router belongs to', type : 'string'}, {}, {name : 'templateid', description : 'The Template ID for the router', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with the router', type : 'set', response : [{name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}]}, {name : 'zonename', description : 'The Zone name for the router', type : 'string'}, {name : 'isredundantrouter', description : 'If this router is an redundant virtual router', type : 'boolean'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'healthcheckresults', description : 'Last executed health check result for the router', type : 'list', response : [{name : 'checktype', description : 'The type of the health check - basic or advanced', type : 'string'}, {name : 'success', description : 'The result of the health check if available', type : 'boolean'}, {name : 'lastupdated', description : 'The date this VPC was created', type : 'date'}, {name : 'details', description : 'Detailed response generated on running health check', type : 'string'}, {name : 'checkname', description : 'The name of the health check on the router', type : 'string'}, {name : 'status', description : 'the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}', type : 'routerhealthstatus'}]}, {name : 'ip6dns1', description : 'The first IPv6 DNS for the router', type : 'string'}, {name : 'templatename', description : 'The Template name for the router', type : 'string'}, {name : 'guestnetworkid', description : 'The ID of the corresponding guest Network', type : 'string'}, {name : 'domainid', description : 'The domain ID associated with the router', type : 'string'}, {name : 'vpcid', description : 'VPC the router belongs to', type : 'string'}, {name : 'scriptsversion', description : 'The version of scripts', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'dns1', description : 'The first DNS for the router', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the router', type : 'string'}, {name : 'account', description : 'The Account associated with the router', type : 'string'}, {name : 'healthchecksfailed', description : 'True if any health checks had failed', type : 'boolean'}, {name : 'guestnetmask', description : 'The guest netmask for the router', type : 'string'}, {name : 'linklocalnetworkid', description : 'The ID of the corresponding link local Network', type : 'string'}, {name : 'project', description : 'The project name of the address', type : 'string'}, {name : 'dns2', description : 'The second DNS for the router', type : 'string'}, {name : 'vpcname', description : 'The name of VPC the router belongs to', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the router', type : 'string'}, {name : 'publicip', description : 'The public IP address for the router', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the router', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the router', type : 'string'}, {name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {name : 'ip6dns2', description : 'The second IPv6 DNS for the router', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the router', type : 'string'}], httprequesttype : 'POST'}, {name : 'removeVirtualMachinesFromKubernetesCluster', description : 'Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.', since : '4.19.0', isasync : False, related : '', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'virtualmachineids', description : 'The IDs of the VMs to remove from the cluster', type : 'list', length : 255, required : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}], httprequesttype : 'POST'}, {name : 'listKubernetesClusters', description : 'Lists Kubernetes clusters', isasync : False, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'clustertype', description : 'Type of the cluster: CloudManaged, ExternalManaged', type : 'string', length : 255, required : False, since : '4.19.0'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : False, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {name : 'name', description : 'Name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'state', description : 'State of the Kubernetes cluster', type : 'string', length : 255, required : False}], response : [{name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'createAutoScaleVmGroup', description : 'Creates and automatically starts an Instance based on a service offering, disk offering, and Template.', isasync : True, related : 'disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup', params : [{name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'uuid', length : 255, required : True, related : 'createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile'}, {name : 'scaleuppolicyids', description : 'List of scaleup autoscale policies', type : 'list', length : 255, required : True, related : 'listAutoScalePolicies,updateAutoScalePolicy'}, {name : 'name', description : 'The name of the autoscale Instance Group', type : 'string', length : 255, required : False, since : '4.18.0'}, {name : 'maxmembers', description : 'The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.', type : 'integer', length : 255, required : True}, {name : 'lbruleid', description : 'The ID of the load balancer rule', type : 'uuid', length : 255, required : True, related : 'createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules'}, {name : 'fordisplay', description : 'An optional field, whether to the display the group to the end user or not', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'scaledownpolicyids', description : 'List of scaledown autoscale policies', type : 'list', length : 255, required : True, related : 'listAutoScalePolicies,updateAutoScalePolicy'}, {name : 'minmembers', description : 'The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.', type : 'integer', length : 255, required : True}, {name : 'interval', description : 'The frequency in which the performance counters to be collected', type : 'integer', length : 255, required : False}], response : [{name : 'privateport', description : 'The private port', type : 'string'}, {name : 'maxmembers', description : 'The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.', type : 'int'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'minmembers', description : 'The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.', type : 'int'}, {name : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {}, {name : 'lbprovider', description : 'The LB provider of the guest Network the LB rule belongs to', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}, {name : 'publicport', description : 'The public port', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'project', description : 'The project name of the Instance group', type : 'string'}, {name : 'state', description : 'The current state of the AutoScale Instance Group', type : 'string'}, {name : 'projectid', description : 'The project id of the Instance group', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the guest Network the LB rule belongs to', type : 'string'}, {name : 'publicip', description : 'The public IP address', type : 'string'}, {name : 'created', description : 'The date when this Instance group was created', type : 'date'}, {name : 'domainpath', description : 'path of the domain to which the vm group belongs', type : 'string'}, {name : 'publicipid', description : 'The public IP address ID', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance group', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {name : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {name : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}], httprequesttype : 'POST'}, {name : 'createNetworkPermissions', description : 'Updates network permissions.', since : '4.17.0', isasync : False, params : [{name : 'projectids', description : 'A comma delimited list of projects within owner\'s domain. If specified, "op" parameter has to be passed in.', type : 'list', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'accounts', description : 'A comma delimited list of accounts within owner\'s domain. If specified, "op" parameter has to be passed in.', type : 'list', length : 255, required : False}, {name : 'networkid', description : 'The network ID', type : 'uuid', length : 255, required : True, related : 'createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'accountids', description : 'A comma delimited list of account IDs within owner\'s domain. If specified, "op" parameter has to be passed in.', type : 'list', length : 255, required : False, related : 'createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}], httprequesttype : 'POST'}, {name : 'deleteResourceIcon', description : 'Deletes the resource icon from the specified resource(s)', since : '4.16.0.0', isasync : False, params : [{name : 'resourceids', description : 'List of resources to upload the icon/image for', type : 'list', length : 255, required : True}, {name : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : True}], response : [{}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'checkVolume', description : 'Check the volume for any errors or leaks and also repairs when repair parameter is passed, this is currently supported for KVM only', since : '4.19.1', isasync : True, related : 'attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume', params : [{name : 'id', description : 'The ID of the volume', type : 'uuid', length : 255, required : True, related : 'attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}, {name : 'repair', description : 'parameter to repair the volume, leaks or all are the possible values', type : 'string', length : 255, required : False}], response : [{name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'deviceid', description : 'The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.', type : 'long'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {}, {name : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {name : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'vmstate', description : 'State of the Instance', type : 'string'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'deletePrivateGateway', description : 'Deletes a Private gateway', isasync : True, params : [{name : 'id', description : 'The ID of the private gateway', type : 'uuid', length : 255, required : True, related : 'createPrivateGateway,createPrivateGateway,listPrivateGateways'}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {}], httprequesttype : 'POST'}, {name : 'disableAutoScaleVmGroup', description : 'Disables an AutoScale Instance Group', isasync : True, related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup', params : [{name : 'id', description : 'The ID of the autoscale group', type : 'uuid', length : 255, required : True, related : 'disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup'}], response : [{name : 'publicip', description : 'The public IP address', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {name : 'privateport', description : 'The private port', type : 'string'}, {name : 'lbprovider', description : 'The LB provider of the guest Network the LB rule belongs to', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the guest Network the LB rule belongs to', type : 'string'}, {name : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'projectid', description : 'The project id of the Instance group', type : 'string'}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'minmembers', description : 'The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.', type : 'int'}, {name : 'publicipid', description : 'The public IP address ID', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance group', type : 'string'}, {name : 'publicport', description : 'The public port', type : 'string'}, {name : 'created', description : 'The date when this Instance group was created', type : 'date'}, {name : 'maxmembers', description : 'The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.', type : 'int'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'state', description : 'The current state of the AutoScale Instance Group', type : 'string'}, {name : 'project', description : 'The project name of the Instance group', type : 'string'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainpath', description : 'path of the domain to which the vm group belongs', type : 'string'}, {name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {}], httprequesttype : 'POST'}, {name : 'listSystemVms', description : 'List System VMs.', isasync : False, related : 'migrateSystemVm,startSystemVm,changeServiceForSystemVm', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'The Zone ID of the system VM', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'systemvmtype', description : 'The system VM type. Possible types are "consoleproxy" and "secondarystoragevm".', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'name', description : 'The name of the system VM', type : 'string', length : 255, required : False}, {name : 'state', description : 'The state of the system VM', type : 'string', length : 255, required : False}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string', length : 255, required : False, since : '4.20.1'}, {name : 'storageid', description : "The storage ID where Instance's volumes belong to", type : 'uuid', length : 255, required : False, since : '3.0.1', related : 'cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}, {name : 'podid', description : 'The Pod ID of the system VM', type : 'uuid', length : 255, required : False, related : 'createPod,listPods,updatePod,createManagementNetworkIpRange'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the system VM', type : 'uuid', length : 255, required : False, related : 'listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm'}, {name : 'hostid', description : 'The host ID of the system VM', type : 'uuid', length : 255, required : False, related : 'addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost'}], response : [{name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}], httprequesttype : 'GET'}, {name : 'createVMSchedule', description : 'Create Instance Schedule', since : '4.19.0', isasync : False, related : 'updateVMSchedule', params : [{name : 'enabled', description : 'Enable Instance schedule. Defaults to true', type : 'boolean', length : 255, required : False}, {name : 'virtualmachineid', description : 'ID of the Instance for which schedule is to be defined', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'schedule', description : "Schedule for action on Instance in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", type : 'string', length : 255, required : True}, {name : 'startdate', description : 'Start date from which the schedule becomes active. Defaults to current date plus 1 minute.(Format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'enddate', description : 'End date after which the schedule becomes inactive(Format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'action', description : 'Action to take on the Instance (start/stop/reboot/force_stop/force_reboot).', type : 'string', length : 255, required : True}, {name : 'description', description : 'Description of the schedule', type : 'string', length : 255, required : False}, {name : 'timezone', description : 'Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.', type : 'string', length : 255, required : True}], response : [{name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'schedule', description : 'Cron formatted Instance schedule', type : 'string'}, {name : 'description', description : 'Description of Instance schedule', type : 'string'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {}, {name : 'action', description : 'Action', type : 'action'}, {name : 'virtualmachineid', description : 'ID of Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'The ID of Instance schedule', type : 'string'}, {}, {name : 'enabled', description : 'VM schedule is enabled', type : 'boolean'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}], httprequesttype : 'POST'}, {name : 'createResourceSchedule', description : 'Create Resource Schedule', since : '4.23.0', isasync : False, related : 'listResourceSchedule,updateResourceSchedule', params : [{name : 'resourceid', description : 'ID of the resource for which schedule is to be defined', type : 'string', length : 255, required : True}, {name : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : True}, {name : 'startdate', description : 'Start date from which the schedule becomes active. Defaults to current date plus 1 minute. (Format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'action', description : 'Action to take on the resource.', type : 'string', length : 255, required : True}, {name : 'schedule', description : "Schedule for action on resource in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", type : 'string', length : 255, required : True}, {name : 'enabled', description : 'Enable schedule. Defaults to true', type : 'boolean', length : 255, required : False}, {name : 'description', description : 'Description of the schedule', type : 'string', length : 255, required : False}, {name : 'enddate', description : 'End date after which the schedule becomes inactive. (Format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'details', description : 'Map of (key/value pairs) details for the schedule.', type : 'map', length : 255, required : False}, {name : 'timezone', description : 'Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.', type : 'string', length : 255, required : True}], response : [{name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'action', description : 'Action', type : 'action'}, {name : 'id', description : 'The ID of resource schedule', type : 'string'}, {name : 'enabled', description : 'Resource schedule is enabled', type : 'boolean'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {}, {name : 'resourcetype', description : 'Type of the resource', type : 'apicommandresourcetype'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'details', description : 'Schedule details', type : 'map'}, {}, {name : 'description', description : 'Description of resource schedule', type : 'string'}, {name : 'schedule', description : 'Cron formatted resource schedule', type : 'string'}], httprequesttype : 'POST'}, {name : 'createSharedFileSystem', description : 'Create a new Shared File System of specified size and disk offering, attached to the given network', since : '4.20.0', isasync : True, related : 'listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering', params : [{name : 'maxiops', description : 'max iops', type : 'long', length : 255, required : False}, {name : 'serviceofferingid', description : 'the service offering to use for the shared filesystem instance hosting the data. The offering should be HA enabled and the cpu count and memory size should be greater than equal to sharedfsvm.min.cpu.count and sharedfsvm.min.ram.size respectively', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'filesystem', description : 'the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.', type : 'string', length : 255, required : True}, {name : 'projectid', description : 'the project associated with the shared filesystem. Mutually exclusive with account parameter', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'account', description : 'the account associated with the shared filesystem. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'name', description : 'the name of the shared filesystem.', type : 'string', length : 255, required : True}, {name : 'networkid', description : 'network to attach the shared filesystem to', type : 'uuid', length : 255, required : True, related : 'createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'diskofferingid', description : 'the disk offering to use for the underlying storage. This will define the size and other specifications like encryption and qos for the shared filesystem.', type : 'uuid', length : 255, required : True, related : 'createDiskOffering,cloneDiskOffering,listDiskOfferings'}, {name : 'domainid', description : 'the domain ID associated with the shared filesystem. If used with the account parameter returns the shared filesystem associated with the account for the specified domain.If account is NOT provided then the shared filesystem will be assigned to the caller account and domain.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'provider', description : 'the provider to be used for the shared filesystem. The list of providers can be fetched by using the listSharedFileSystemProviders API.', type : 'string', length : 255, required : False}, {name : 'description', description : 'the description for the shared filesystem.', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'the zone id.', type : 'uuid', length : 255, required : True, related : 'createZone,updateZone,listZones,listZones'}, {name : 'size', description : 'the size of the shared filesystem in GiB', type : 'long', length : 255, required : False}, {name : 'miniops', description : 'min iops', type : 'long', length : 255, required : False}], response : [{name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}]}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}]}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {}, {}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteProjectRole', description : 'Delete Project roles in CloudStack', since : '4.15.0', isasync : False, params : [{name : 'id', description : 'ID of the project role to be deleted', type : 'uuid', length : 255, required : True, related : 'createProjectRole,listProjectRoles,updateProjectRole'}, {name : 'projectid', description : 'ID of the project from where the role is to be deleted', type : 'uuid', length : 255, required : True, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'validateUserTwoFactorAuthenticationCode', description : 'Checks the 2FA code for the user.', since : '4.18.0', isasync : False, params : [{name : 'codefor2fa', description : 'Two factor authentication code', type : 'string', length : 255, required : True}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'updateVmwareDc', description : 'Updates a VMware datacenter details for a zone', since : '4.12.0', isasync : False, related : 'addVmwareDc,listVmwareDcs', params : [{name : 'username', description : 'The username required to connect to resource.', type : 'string', length : 255, required : False}, {name : 'isrecursive', description : 'Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.', type : 'boolean', length : 255, required : False}, {name : 'zoneid', description : 'The zone ID', type : 'uuid', length : 255, required : True, related : 'createZone,updateZone,listZones,listZones'}, {name : 'vcenter', description : 'The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.', type : 'string', length : 255, required : False}, {name : 'password', description : 'The password for specified username.', type : 'string', length : 255, required : False}, {name : 'name', description : 'VMware datacenter name.', type : 'string', length : 255, required : False}], response : [{name : 'vcenter', description : 'The VMware vCenter name/ip', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'The VMware Datacenter ID', type : 'string'}, {}, {name : 'zoneid', description : 'The Zone ID associated with this VMware Datacenter', type : 'long'}, {name : 'name', description : 'The VMware Datacenter name', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'changeOfferingForVolume', description : 'Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering', since : '4.17', isasync : True, related : 'attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume', params : [{name : 'miniops', description : 'New minimum number of IOPS for the custom disk offering', type : 'long', length : 255, required : False}, {name : 'shrinkok', description : 'Verify OK to Shrink', type : 'boolean', length : 255, required : False}, {name : 'automigrate', description : 'Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering', type : 'boolean', length : 255, required : False}, {name : 'maxiops', description : 'New maximum number of IOPS for the custom disk offering', type : 'long', length : 255, required : False}, {name : 'id', description : 'The ID of the volume', type : 'uuid', length : 255, required : True, related : 'attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}, {name : 'diskofferingid', description : 'New disk offering ID', type : 'uuid', length : 255, required : True, related : 'createDiskOffering,cloneDiskOffering,listDiskOfferings'}, {name : 'size', description : 'New volume size in GB for the custom disk offering', type : 'long', length : 255, required : False}], response : [{name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'deviceid', description : 'The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.', type : 'long'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {name : 'vmstate', description : 'State of the Instance', type : 'string'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'status', description : 'The status of the volume', type : 'string'}, {}, {}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}], httprequesttype : 'POST'}, {name : 'createProjectRole', description : 'Creates a Project role', since : '4.15.0', isasync : False, related : 'listProjectRoles,updateProjectRole', params : [{name : 'description', description : 'The description of the Project role', type : 'string', length : 255, required : False}, {name : 'name', description : 'Creates a project role with this unique name', type : 'string', length : 255, required : True}, {name : 'projectid', description : 'ID of project where role is being created', type : 'uuid', length : 255, required : True, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}], response : [{name : 'ispublic', description : 'Indicates whether the role will be visible to all Users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).', type : 'boolean'}, {name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'The name of the role', type : 'string'}, {name : 'description', description : 'The description of the role', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {}, {name : 'id', description : 'The ID of the role', type : 'string'}], httprequesttype : 'POST'}, {name : 'createIpv6FirewallRule', description : 'Creates an IPv6 firewall rule in the given Network (the Network must not belong to VPC)', isasync : True, related : 'updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule', params : [{name : 'networkid', description : 'The Network of the Instance the Ipv6 firewall rule will be created for', type : 'uuid', length : 255, required : True, related : 'createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'icmpcode', description : 'Error code for this ICMP message', type : 'integer', length : 255, required : False}, {name : 'icmptype', description : 'Type of the ICMP message being sent', type : 'integer', length : 255, required : False}, {name : 'cidrlist', description : 'The source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).', type : 'list', length : 255, required : False}, {name : 'startport', description : 'The starting port of Ipv6 firewall rule', type : 'integer', length : 255, required : False}, {name : 'protocol', description : 'The protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number', type : 'string', length : 255, required : True}, {name : 'destcidrlist', description : 'The destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).', type : 'list', length : 255, required : False}, {name : 'traffictype', description : 'The traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified', type : 'string', length : 255, required : False}, {name : 'fordisplay', description : 'An optional field, whether to the display the rule to the end User or not', type : 'boolean', length : 255, required : False}, {name : 'endport', description : 'The ending port of Ipv6 firewall rule', type : 'integer', length : 255, required : False}], response : [{name : 'privateport', description : "The starting port of port forwarding rule's private port range", type : 'string'}, {name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'list', response : [{name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}]}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'state', description : 'The state of the rule', type : 'string'}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {}, {name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {name : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'privateendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {}, {name : 'networkid', description : 'The ID of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', type : 'string'}, {name : 'publicport', description : "The starting port of port forwarding rule's public port range", type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID for the port forwarding rule', type : 'string'}, {name : 'virtualmachinedisplayname', description : 'The Instance display name for the port forwarding rule', type : 'string'}, {name : 'id', description : 'The ID of the port forwarding rule', type : 'string'}, {name : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}], httprequesttype : 'POST'}, {name : 'listBackups', description : 'Lists Instance backups', since : '4.14.0', isasync : False, related : 'updateBackupSchedule', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'name', description : 'list backups by name', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'uuid', length : 255, required : False, related : 'assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'id', description : 'ID of the backup', type : 'uuid', length : 255, required : False, related : 'updateBackupSchedule,listBackups'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'zoneid', description : 'List backups by zone id', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'listvmdetails', description : 'list backups with VM details', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'backupofferingid', description : 'list backups by backup offering', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listBackupProviderOfferings,importBackupOffering,cloneBackupOffering,listBackupOfferings,updateBackupOffering,createBackupOffering'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'status', description : 'list backups by status', type : 'string', length : 255, required : False, since : '4.23.0'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}], response : [{name : 'uncompressedsize', description : 'Backup uncompressed size in bytes. Only defined if backup is compressed.', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {name : 'id', description : 'ID of the Instance backup', type : 'string'}, {name : 'intervaltype', description : 'Interval type of the backup', type : 'string'}, {name : 'domainid', description : 'Domain ID', type : 'string'}, {name : 'tocheckpointid', description : 'Next checkpoint ID for incremental backups', type : 'string'}, {name : 'account', description : 'Account name', type : 'string'}, {name : 'status', description : 'Backup status', type : 'status'}, {name : 'vmdetails', description : 'Lists the vm specific details for the backup', type : 'map'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'backupofferingname', description : 'Backup offering name', type : 'string'}, {name : 'created', description : 'Backup date', type : 'date'}, {name : 'compressionstatus', description : 'Backup compression status.', type : 'compressionstatus'}, {name : 'name', description : 'name of the backup', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'size', description : 'Backup size in bytes', type : 'long'}, {name : 'accountid', description : 'Account id', type : 'string'}, {name : 'validationstatus', description : 'Backup validation status.', type : 'validationstatus'}, {name : 'volumes', description : 'Backed up volumes', type : 'string'}, {name : 'backupofferingid', description : 'Backup offering id', type : 'string'}, {}, {name : 'fromcheckpointid', description : 'Previous active checkpoint ID for incremental backups', type : 'string'}, {name : 'domain', description : 'Domain name', type : 'string'}, {name : 'vmbackupofferingremoved', description : 'The backup offering corresponding to this backup was removed from the VM', type : 'boolean'}, {name : 'hostid', description : 'Host ID where the backup is running', type : 'string'}, {}, {name : 'type', description : 'Backup type', type : 'string'}, {name : 'zone', description : 'Zone name', type : 'string'}, {name : 'externalid', description : 'External backup id', type : 'string'}, {name : 'virtualsize', description : 'Backup protected (virtual) size in bytes', type : 'long'}, {name : 'description', description : 'description for the backup', type : 'string'}, {name : 'isbackupvmexpunged', description : 'Indicates whether the VM from which the backup was taken is expunged or not', type : 'boolean'}], httprequesttype : 'GET'}, {name : 'updateDnsZone', description : "Updates a DNS Zone's metadata", since : '4.23.0', isasync : False, related : 'createDnsZone,listDnsZones', params : [{name : 'description', description : 'The description of the DNS zone to be updated', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the DNS zone', type : 'uuid', length : 255, required : True, related : 'createDnsZone,listDnsZones,updateDnsZone'}], response : [{name : 'networkid', description : 'ID of the network this zone is associated with', type : 'string'}, {name : 'account', description : 'the account associated with the DNS zone', type : 'string'}, {name : 'networkname', description : 'Name of the network this zone is associated with', type : 'string'}, {name : 'state', description : 'The state of the zone (Active/Inactive)', type : 'state'}, {name : 'dnsserveraccount', description : 'the account name of the DNS server owner', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domain', description : 'the name of the domain associated with the DNS zone', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the DNS server', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'dnsserverid', description : 'ID of the DNS server this zone belongs to', type : 'string'}, {name : 'type', description : 'The type of the zone (Public/Private)', type : 'zonetype'}, {name : 'name', description : 'Name of the DNS zone', type : 'string'}, {name : 'description', description : 'Description for the DNS zone', type : 'string'}, {name : 'id', description : 'ID of the DNS zone', type : 'string'}, {name : 'dnsservername', description : 'the name of the DNS server hosting this zone', type : 'string'}], httprequesttype : 'POST'}, {name : 'setupUserTwoFactorAuthentication', description : 'Setup the 2FA for the user.', since : '4.18.0', isasync : False, related : '', params : [{name : 'userid', description : 'Optional: the id of the User for which 2FA has to be disabled', type : 'uuid', length : 255, required : False, related : 'createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser'}, {name : 'provider', description : 'Two factor authentication code', type : 'string', length : 255, required : False}, {name : 'enable', description : 'Enabled by default, provide false to disable 2FA', type : 'boolean', length : 255, required : False}], response : [{name : 'secretcode', description : 'Secret code that needs to be registered with authenticator', type : 'string'}, {}, {name : 'id', description : 'The user ID', type : 'string'}, {name : 'username', description : 'The user name', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'accountid', description : 'The Account ID of the user', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'deleteWebhookFilter', description : 'Deletes Webhook filter', since : '4.20.0', isasync : False, params : [{name : 'id', description : 'The ID of the Webhook filter', type : 'uuid', length : 255, required : False, related : 'listWebhookFilters'}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,listWebhooks,updateWebhook,listWebhookDeliveries,addWebhookFilter'}], response : [{}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'createDnsZone', description : 'Creates a new DNS Zone on a specific server', since : '4.23.0', isasync : True, related : 'listDnsZones', params : [{name : 'type', description : 'The type of zone (Public, Private). Defaults to Public.', type : 'string', length : 255, required : False}, {name : 'existing', description : 'If true, imports an existing DNS zone from the DNS provider into CloudStack. If false, creates the zone in the DNS provider and registers it in CloudStack. Default is false', type : 'boolean', length : 255, required : False, related : 'createDnsZone,listDnsZones'}, {name : 'name', description : 'The name of the DNS zone (e.g. example.com)', type : 'string', length : 255, required : True}, {name : 'dnsserverid', description : 'The ID of the DNS server to host this zone', type : 'uuid', length : 255, required : True, related : 'addDnsServer,listDnsServers,updateDnsServer'}, {name : 'description', description : 'The description of the DNS zone', type : 'string', length : 255, required : False}], response : [{name : 'state', description : 'The state of the zone (Active/Inactive)', type : 'state'}, {name : 'domainid', description : 'the ID of the domain associated with the DNS server', type : 'string'}, {name : 'dnsserveraccount', description : 'the account name of the DNS server owner', type : 'string'}, {name : 'account', description : 'the account associated with the DNS zone', type : 'string'}, {name : 'description', description : 'Description for the DNS zone', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'type', description : 'The type of the zone (Public/Private)', type : 'zonetype'}, {name : 'networkid', description : 'ID of the network this zone is associated with', type : 'string'}, {name : 'networkname', description : 'Name of the network this zone is associated with', type : 'string'}, {name : 'dnsserverid', description : 'ID of the DNS server this zone belongs to', type : 'string'}, {name : 'dnsservername', description : 'the name of the DNS server hosting this zone', type : 'string'}, {name : 'domain', description : 'the name of the domain associated with the DNS zone', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'id', description : 'ID of the DNS zone', type : 'string'}, {name : 'name', description : 'Name of the DNS zone', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteKubernetesCluster', description : 'Deletes a Kubernetes cluster', isasync : True, params : [{name : 'cleanup', description : 'Destroy attached instances of the ExternalManaged Cluster. Default: false', type : 'boolean', length : 255, required : False, since : '4.19.0'}, {name : 'expunge', description : 'Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false', type : 'boolean', length : 255, required : False, since : '4.19.0'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listWebhooks', description : 'Lists Webhooks', since : '4.20.0', isasync : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries,addWebhookFilter', params : [{name : 'id', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,listWebhooks,updateWebhook,listWebhookDeliveries,addWebhookFilter'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'state', description : 'The state of the Webhook', type : 'string', length : 255, required : False}, {name : 'name', description : 'The name of the Webhook', type : 'string', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'scope', description : 'The scope of the Webhook', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'created', description : 'The date when this Webhook was created', type : 'date'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Webhook exists', type : 'string'}, {}, {name : 'description', description : 'The description of the Webhook', type : 'string'}, {name : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Webhook exists', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', type : 'string'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'account', description : 'The account associated with the Webhook', type : 'string'}, {name : 'project', description : 'the project name of the Kubernetes cluster', type : 'string'}, {name : 'secretkey', description : 'The secret key for the Webhook', type : 'string'}, {}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}, {name : 'projectid', description : 'the project id of the Kubernetes cluster', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'listAffectedVmsForStorageScopeChange', description : 'List user and system VMs that need to be stopped and destroyed respectively for changing the scope of the storage pool from Zone to Cluster.', since : '4.19.1', isasync : False, related : '', params : [{name : 'clusterid', description : 'the Id of the cluster the scope of the storage pool is being changed to', type : 'uuid', length : 255, required : True, related : 'addCluster,updateCluster'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'storageid', description : 'the Id of the storage pool on which change scope operation is being done', type : 'uuid', length : 255, required : True, related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'clusterid', description : 'the cluster ID for the VM', type : 'string'}, {}, {}, {name : 'hostname', description : 'the hostname for the VM', type : 'string'}, {name : 'id', description : 'the ID of the VM', type : 'string'}, {name : 'hostid', description : 'the host ID for the VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'clustername', description : 'the cluster name for the VM', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'the name of the VM', type : 'string'}, {name : 'type', description : 'the type of VM', type : 'string'}], httprequesttype : 'GET'}, {name : 'executeWebhookDelivery', description : 'Executes a Webhook delivery', since : '4.20.0', isasync : False, related : '', params : [{name : 'secretkey', description : 'Secret key of the Webhook delivery', type : 'string', length : 255, required : False}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries,addWebhookFilter'}, {name : 'sslverification', description : 'If set to true then SSL verification will be done for the Webhook delivery otherwise not', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The ID of the Webhook delivery for redelivery', type : 'uuid', length : 255, required : False, related : 'executeWebhookDelivery'}, {name : 'payload', description : 'Payload of the Webhook delivery', type : 'string', length : 255, required : False}, {name : 'payloadurl', description : 'Payload URL of the Webhook delivery', type : 'string', length : 255, required : False}], response : [{name : 'id', description : 'The ID of the Webhook delivery', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'payload', description : 'The payload of the webhook delivery', type : 'string'}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'string'}, {name : 'response', description : 'The response of the webhook delivery', type : 'string'}, {name : 'managementserverid', description : 'The ID of the management server which executed delivery', type : 'string'}, {name : 'success', description : 'Whether Webhook delivery succeeded or not', type : 'boolean'}, {}, {name : 'headers', description : 'The headers of the webhook delivery', type : 'string'}, {name : 'eventtype', description : 'The type of the event', type : 'string'}, {name : 'eventid', description : 'The ID of the event', type : 'string'}, {}, {name : 'managementservername', description : 'The name of the management server which executed delivery', type : 'string'}, {name : 'enddate', description : 'The end time of the Webhook delivery', type : 'date'}, {name : 'webhookname', description : 'The name of the Webhook', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'startdate', description : 'The start time of the Webhook delivery', type : 'date'}], httprequesttype : 'POST'}, {name : 'updateAutoScaleVmGroup', description : 'Updates an existing autoscale Instance group.', isasync : True, related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups', params : [{name : 'customid', description : 'An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only', type : 'string', length : 255, required : False, since : '4.4'}, {name : 'fordisplay', description : 'An optional field, whether to the display the group to the end user or not', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'name', description : 'The name of the autoscale vmgroup', type : 'string', length : 255, required : False, since : '4.18.0'}, {name : 'scaledownpolicyids', description : 'List of scaledown autoscale policies', type : 'list', length : 255, required : False, related : 'listAutoScalePolicies,updateAutoScalePolicy'}, {name : 'minmembers', description : 'The minimum number of members in the vmgroup, the number of Instances in the Instance group will be equal to or more than this number.', type : 'integer', length : 255, required : False}, {name : 'interval', description : 'The frequency in which the performance counters to be collected', type : 'integer', length : 255, required : False}, {name : 'scaleuppolicyids', description : 'List of scaleup autoscale policies', type : 'list', length : 255, required : False, related : 'listAutoScalePolicies,updateAutoScalePolicy'}, {name : 'maxmembers', description : 'The maximum number of members in the vmgroup, The number of Instances in the Instance group will be equal to or less than this number.', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the autoscale group', type : 'uuid', length : 255, required : True, related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup'}], response : [{name : 'publicip', description : 'The public IP address', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the vm group belongs', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the guest Network the LB rule belongs to', type : 'string'}, {name : 'maxmembers', description : 'The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.', type : 'int'}, {name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {name : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {name : 'projectid', description : 'The project id of the Instance group', type : 'string'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {name : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {name : 'domain', description : 'The domain name of the Instance group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'project', description : 'The project name of the Instance group', type : 'string'}, {name : 'privateport', description : 'The private port', type : 'string'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'publicport', description : 'The public port', type : 'string'}, {}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}, {}, {name : 'lbprovider', description : 'The LB provider of the guest Network the LB rule belongs to', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'created', description : 'The date when this Instance group was created', type : 'date'}, {name : 'minmembers', description : 'The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.', type : 'int'}, {name : 'state', description : 'The current state of the AutoScale Instance Group', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'publicipid', description : 'The public IP address ID', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listVirtualMachines', description : 'List the Instances owned by the account.', isasync : False, related : 'assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm', params : [{name : 'groupid', description : 'The group ID', type : 'uuid', length : 255, required : False, related : 'createInstanceGroup,updateInstanceGroup'}, {name : 'extensionid', description : 'The ID of the Orchestrator extension for the VM', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'createExtension,listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension'}, {name : 'userdataid', description : 'the instances by userdata', type : 'uuid', length : 255, required : False, since : '4.20.1', related : 'listCniConfiguration'}, {name : 'displayvm', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'userid', description : 'The user ID that created the Instance and is under the Account that owns the Instance', type : 'uuid', length : 255, required : False, related : 'createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser'}, {name : 'keypair', description : 'List Instances by SSH keypair name', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'haenable', description : 'List by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabled', type : 'boolean', length : 255, required : False, since : '4.15'}, {name : 'showicon', description : 'Flag to display the resource icon for Instances', type : 'boolean', length : 255, required : False, since : '4.16.0.0'}, {name : 'vpcid', description : 'List Instances by VPC', type : 'uuid', length : 255, required : False, related : 'listVPCs,createVPC,listVPCs,updateVPC,migrateVPC'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string', length : 255, required : False, since : '4.20.1'}, {name : 'id', description : 'The ID of the Instance', type : 'uuid', length : 255, required : False, related : 'assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'isoid', description : 'List Instances by ISO', type : 'uuid', length : 255, required : False}, {name : 'autoscalevmgroupid', description : 'The ID of AutoScaling Instance Group', type : 'uuid', length : 255, required : False, since : '4.18.0', related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups'}, {name : 'gpuenabled', description : 'Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'ids', description : 'The IDs of the Instances, mutually exclusive with id', type : 'list', length : 255, required : False, since : '4.4', related : 'assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'podid', description : 'The pod ID', type : 'uuid', length : 255, required : False, related : 'createPod,listPods,updatePod,createManagementNetworkIpRange'}, {name : 'isvnf', description : 'flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.', type : 'boolean', length : 255, required : False, since : '4.19.0'}, {name : 'backupofferingid', description : 'List by the backup offering', type : 'uuid', length : 255, required : False, since : '4.17', related : 'listBackupProviderOfferings,importBackupOffering,cloneBackupOffering,listBackupOfferings,updateBackupOffering,createBackupOffering'}, {name : 'accumulate', description : 'Accumulates the Instance metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.', type : 'boolean', length : 255, required : False, since : '4.17.0'}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", type : 'boolean', length : 255, required : False}, {name : 'hostid', description : 'The host ID', type : 'uuid', length : 255, required : False, related : 'addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'hypervisor', description : 'The target hypervisor for the Template', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'storageid', description : "The storage ID where Instance's volumes belong to", type : 'uuid', length : 255, required : False, related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}, {name : 'leased', description : 'Whether to return only leased instances', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'state', description : 'State of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'clusterid', description : 'The cluster ID', type : 'uuid', length : 255, required : False, since : '4.16.0', related : 'addCluster,updateCluster'}, {name : 'securitygroupid', description : 'The security group ID', type : 'uuid', length : 255, required : False, since : '4.15', related : 'createSecurityGroup,updateSecurityGroup'}, {name : 'affinitygroupid', description : 'List Instances by affinity group', type : 'uuid', length : 255, required : False, related : 'createAffinityGroup,listAffinityGroups'}, {name : 'templateid', description : 'List Instances by Template', type : 'uuid', length : 255, required : False, related : 'prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'details', description : 'Comma separated list of Instance details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.', type : 'list', length : 255, required : False}, {name : 'serviceofferingid', description : 'List by the service offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject'}, {name : 'forvirtualnetwork', description : 'List by Network type; true if need to list Instances using Virtual Network, false otherwise', type : 'boolean', length : 255, required : False}, {name : 'userdata', description : "Whether to return the Instances' User data or not. By default, User data will not be returned.", type : 'boolean', length : 255, required : False, since : '4.18.0.0'}, {name : 'name', description : 'Name of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)', type : 'string', length : 255, required : False}, {name : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}]}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}]}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}]}]}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}]}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}]}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}]}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}], httprequesttype : 'GET'}, {name : 'upgradeKubernetesCluster', description : 'Upgrades a running CloudManaged Kubernetes cluster', isasync : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for upgrade', type : 'uuid', length : 255, required : True, related : 'addKubernetesSupportedVersion,getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion'}], response : [{name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'revertToVMSnapshot', description : 'Revert Instance from a vmsnapshot.', since : '4.2.0', isasync : True, related : 'assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm', params : [{name : 'vmsnapshotid', description : 'The ID of the Instance Snapshot', type : 'uuid', length : 255, required : True, related : 'listVMSnapshot,createVMSnapshot'}], response : [{name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}]}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}, {name : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}]}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}]}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}]}, {name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}]}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}]}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}]}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}]}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}]}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}], httprequesttype : 'POST'}, {name : 'recoverSharedFileSystem', description : 'Recover a Shared FileSystem by id', since : '4.20.0', isasync : False, params : [{name : 'id', description : 'the ID of the shared filesystem to recover', type : 'uuid', length : 255, required : False, related : 'listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}], httprequesttype : 'POST'}, {name : 'addWebhookFilter', description : 'Adds a Webhook filter', since : '4.23.0', isasync : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries', params : [{name : 'mode', description : 'Mode for the Webhook filter - Include or Exclude', type : 'string', length : 255, required : False}, {name : 'value', description : 'Value for the Webhook which that will be matched', type : 'string', length : 255, required : True}, {name : 'matchtype', description : 'Match type for the Webhook filter - Exact, Prefix, Suffix or Contains', type : 'string', length : 255, required : False}, {name : 'webhookid', description : 'ID for the Webhook', type : 'uuid', length : 255, required : True, related : 'createWebhook,updateWebhook,listWebhookDeliveries,addWebhookFilter'}], response : [{name : 'projectid', description : 'the project id of the Kubernetes cluster', type : 'string'}, {name : 'secretkey', description : 'The secret key for the Webhook', type : 'string'}, {}, {}, {name : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Webhook exists', type : 'string'}, {name : 'created', description : 'The date when this Webhook was created', type : 'date'}, {name : 'description', description : 'The description of the Webhook', type : 'string'}, {name : 'account', description : 'The account associated with the Webhook', type : 'string'}, {name : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {name : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Webhook exists', type : 'string'}, {name : 'project', description : 'the project name of the Kubernetes cluster', type : 'string'}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listNetworkProtocols', description : 'Lists details of network protocols', since : '4.19.0', isasync : False, related : '', params : [{name : 'option', description : 'The option of network protocols. Supported values are: protocolnumber, icmptype.', type : 'string', length : 255, required : True}], response : [{name : 'index', description : 'the index (ID, Value, Code, Type, Option, etc) of the protocol parameter', type : 'integer'}, {name : 'description', description : 'the description of the protocol parameter', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'the name of the protocol parameter', type : 'string'}, {name : 'details', description : 'the details of the protocol parameter', type : 'map'}], httprequesttype : 'GET'}, {name : 'listGuiThemes', description : 'Lists GUI themes.', since : '4.21.0.0', isasync : False, related : 'createGuiTheme', params : [{name : 'listonlydefaulttheme', description : 'Whether to only list the default theme.', type : 'boolean', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'accountid', description : 'The ID of the account to be filtered.', type : 'uuid', length : 255, required : False, related : 'disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts'}, {name : 'listall', description : 'Whether to list all themes.', type : 'boolean', length : 255, required : False}, {name : 'showpublic', description : 'Whether to list public themes.', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The theme ID.', type : 'uuid', length : 255, required : False, related : 'listGuiThemes,createGuiTheme'}, {name : 'domainid', description : 'The ID of the domain to be filtered.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'showremoved', description : 'Whether to list removed themes.', type : 'boolean', length : 255, required : False}, {name : 'commonname', description : 'The internet Common Name (CN) to be filtered.', type : 'string', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'name', description : 'The name of the theme.', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'recursivedomains', description : 'Whether to consider the subdomains of the informed domain IDs.', type : 'boolean'}, {name : 'jsonconfiguration', description : 'The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.', type : 'string'}, {name : 'name', description : 'Name of the GUI theme.', type : 'string'}, {name : 'id', description : 'ID of the custom GUI theme.', type : 'string'}, {name : 'accountids', description : 'A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.', type : 'string'}, {}, {name : 'loginbasedomain', description : 'The ACS domain to be used as base for the login when accessing the GUI through the common name defined in the theme. If a common name is not defined, this parameter is ignored on the GUI.', type : 'string'}, {name : 'domainids', description : 'A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.', type : 'string'}, {name : 'commonnames', description : 'A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'removed', description : 'When the GUI theme was removed.', type : 'date'}, {name : 'description', description : 'Description of the GUI theme.', type : 'string'}, {name : 'created', description : 'When the GUI theme was created.', type : 'date'}, {name : 'css', description : 'The CSS to be retrieved and imported into the GUI when matching the theme access configurations.', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'ispublic', description : 'Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.', type : 'boolean'}], httprequesttype : 'GET'}, {name : 'deleteCniConfiguration', description : 'Deletes a CNI Configuration', since : '4.21.0', isasync : False, params : [{name : 'id', description : 'The ID of the Userdata', type : 'uuid', length : 255, required : True, related : 'listCniConfiguration'}, {name : 'domainid', description : 'An optional domainId for the userdata. If the account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'account', description : 'An optional account for the userdata. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'An optional project for the userdata', type : 'uuid', length : 255, required : False, related : 'activateProject,createProject,suspendProject,updateProject'}], response : [{}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listVmwareDcs', description : 'Retrieves VMware DC(s) associated with a zone.', isasync : False, related : 'addVmwareDc', params : [{name : 'zoneid', description : 'Id of the CloudStack zone.', type : 'uuid', length : 255, required : True, related : 'createZone,listZones,listZones'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'id', description : 'The VMware Datacenter ID', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'vcenter', description : 'The VMware vCenter name/ip', type : 'string'}, {name : 'zoneid', description : 'The Zone ID associated with this VMware Datacenter', type : 'long'}, {name : 'name', description : 'The VMware Datacenter name', type : 'string'}, {}], httprequesttype : 'GET'}, {name : 'deleteBackupSchedule', description : 'Deletes the backup schedule of a Instance', since : '4.14.0', isasync : False, params : [{name : 'virtualmachineid', description : 'ID of the VM from which all backup schedules will be deleted.', type : 'uuid', length : 255, required : False, related : 'assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'id', description : "ID of the backup schedule to be deleted. It has precedence over the 'virtualmachineid' parameter, i.e., when the 'id' parameter is specified, the 'virtualmachineid' parameter will be ignored.", type : 'uuid', length : 255, required : False, since : '4.20.1', related : 'listBackupSchedule'}], response : [{}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'listResourceSchedule', description : 'List Resource Schedules', since : '4.23.0', isasync : False, related : 'updateResourceSchedule', params : [{name : 'enabled', description : 'Filter by enabled status.', type : 'boolean', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'resourceid', description : 'ID of the resource for which schedules are to be listed.', type : 'string', length : 255, required : True}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'action', description : 'Action to take on the resource.', type : 'string', length : 255, required : False}, {name : 'id', description : 'ID of the schedule', type : 'uuid', length : 255, required : False, related : 'listResourceSchedule,updateResourceSchedule'}, {name : 'resourcetype', description : 'Type of the resource.', type : 'string', length : 255, required : True}, {name : 'ids', description : 'comma separated list of schedule ids', type : 'list', length : 255, required : False, related : 'listResourceSchedule,updateResourceSchedule'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{}, {name : 'resourcetype', description : 'Type of the resource', type : 'apicommandresourcetype'}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'id', description : 'The ID of resource schedule', type : 'string'}, {name : 'description', description : 'Description of resource schedule', type : 'string'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'schedule', description : 'Cron formatted resource schedule', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'enabled', description : 'Resource schedule is enabled', type : 'boolean'}, {name : 'action', description : 'Action', type : 'action'}, {name : 'details', description : 'Schedule details', type : 'map'}], httprequesttype : 'GET'}, {name : 'listVolumesUsageHistory', description : 'Lists volume stats', since : '4.18.0', isasync : False, related : '', params : [{name : 'startdate', description : 'Start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'enddate', description : 'End date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'name', description : 'Name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the volume.', type : 'uuid', length : 255, required : False, related : 'createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'ids', description : 'the IDs of the Volumes, mutually exclusive with id.', type : 'list', length : 255, required : False, related : 'createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}], response : [{}, {name : 'id', description : 'The ID of the volume', type : 'string'}, {name : 'name', description : 'The name of the volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'stats', description : 'The list of VM stats', type : 'list'}], httprequesttype : 'GET'}, {name : 'createProjectRolePermission', description : 'Adds API permissions to a project role', since : '4.15.0', isasync : False, related : 'listProjectRolePermissions', params : [{name : 'permission', description : 'The rule permission, allow or deny. Default: deny.', type : 'string', length : 255, required : True}, {name : 'rule', description : 'The API name or wildcard rule such as list*', type : 'string', length : 255, required : True}, {name : 'description', description : 'The description of the role permission', type : 'string', length : 255, required : False}, {name : 'projectroleid', description : 'ID of the project role', type : 'uuid', length : 255, required : True, related : 'listProjectRoles,updateProjectRole'}, {name : 'projectid', description : 'ID of project where project role permission is to be created', type : 'uuid', length : 255, required : True, related : 'activateProject,createProject,suspendProject'}], response : [{name : 'description', description : 'The description of the role permission', type : 'string'}, {name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'rule', description : 'The api name or wildcard rule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'projectrolename', description : 'The name of the project role to which the role permission belongs', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'permission', description : 'The permission type of the api name or wildcard rule, allow/deny', type : 'string'}, {}, {name : 'id', description : 'The ID of the project role permission', type : 'string'}, {name : 'projectroleid', description : 'The ID of the project role to which the role permission belongs', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteBucket', description : 'Deletes an empty Bucket.', since : '4.19.0', isasync : False, params : [{name : 'id', description : 'The ID of the Bucket', type : 'uuid', length : 255, required : True, related : 'createBucket,listBuckets'}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {}], httprequesttype : 'POST'}, {name : 'createConsoleEndpoint', description : 'Create a console endpoint to connect to a Instance console', since : '4.18.0', isasync : False, related : '', params : [{name : 'virtualmachineid', description : 'ID of the Instance', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'token', description : '(optional) extra security token, valid when the extra validation is enabled', type : 'string', length : 255, required : False}], response : [{name : 'details', description : 'Details in case of an error', type : 'string'}, {}, {name : 'url', description : 'The console url', type : 'string'}, {}, {name : 'websocket', description : 'The console websocket options', type : 'consoleendpointwebsocketresponse'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if the console endpoint is generated properly', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'updateProjectRolePermission', description : 'Updates a project role permission and/or order', since : '4.15.0', isasync : False, params : [{name : 'projectid', description : 'ID of project where project role permission is to be updated', type : 'uuid', length : 255, required : True, related : 'activateProject,createProject,suspendProject'}, {name : 'projectroleid', description : 'ID of the project role', type : 'uuid', length : 255, required : True, related : 'listProjectRoles,updateProjectRole'}, {name : 'projectrolepermissionid', description : 'Project Role permission rule id', type : 'uuid', length : 255, required : False, related : 'listProjectRolePermissions'}, {name : 'ruleorder', description : 'ID of the parent role permission, use 0 to move this rule at the top of the list', type : 'list', length : 255, required : False, related : 'listProjectRolePermissions'}, {name : 'permission', description : 'Rule permission, can be: allow or deny', type : 'string', length : 255, required : False}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'addUserToProject', description : 'Adds User to a project', since : '4.14', isasync : True, params : [{name : 'username', description : 'Name of the User to be added to the project', type : 'string', length : 255, required : True}, {name : 'roletype', description : 'Project role type to be assigned to the User - Admin/Regular', type : 'string', length : 255, required : False}, {name : 'email', description : 'Email ID of User to which invitation to the project is going to be sent', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'ID of the project to add the User to', type : 'uuid', length : 255, required : True, related : 'activateProject,createProject,suspendProject'}, {name : 'projectroleid', description : 'ID of the project role', type : 'uuid', length : 255, required : False, related : 'listProjectRoles,updateProjectRole'}], response : [{}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'resetNetworkPermissions', description : 'Resets Network permissions.', since : '4.17.0', isasync : False, params : [{name : 'networkid', description : 'The Network ID', type : 'uuid', length : 255, required : True, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'listWebhookFilters', description : 'Lists Webhook filters', since : '4.23.0', isasync : False, related : '', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the Webhook delivery', type : 'uuid', length : 255, required : False, related : ''}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'id', description : 'The ID of the Webhook filter', type : 'string'}, {name : 'created', description : 'The type of the Webhook filter', type : 'date'}, {name : 'matchtype', description : 'The type of the Webhook filter', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'mode', description : 'The type of the Webhook filter', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'webhookname', description : 'The name of the Webhook', type : 'string'}, {name : 'value', description : 'The type of the Webhook filter', type : 'string'}, {name : 'type', description : 'The type of the Webhook filter', type : 'string'}, {}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateCondition', description : 'Updates a condition for Instance auto scaling', since : '4.18.0', isasync : True, params : [{name : 'relationaloperator', description : 'Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.', type : 'string', length : 255, required : True}, {name : 'id', description : 'The ID of the condition.', type : 'uuid', length : 255, required : True, related : 'listConditions'}, {name : 'threshold', description : 'Value for which the Counter will be evaluated with the Operator selected.', type : 'long', length : 255, required : True}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], httprequesttype : 'POST'}, {name : 'migrateSystemVm', description : 'Attempts Migration of a System VM to the host specified.', isasync : True, related : 'startSystemVm,changeServiceForSystemVm', params : [{name : 'hostid', description : 'Destination Host ID to migrate Instance to', type : 'uuid', length : 255, required : False, related : 'addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost'}, {name : 'autoselect', description : 'Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default', type : 'boolean', length : 255, required : False, since : '4.16.0'}, {name : 'virtualmachineid', description : 'The ID of the Instance', type : 'uuid', length : 255, required : True, related : 'migrateSystemVm,startSystemVm,changeServiceForSystemVm'}, {name : 'storageid', description : 'Destination storage pool ID to migrate Instance volumes to. Required for migrating the root disk volume', type : 'uuid', length : 255, required : False, since : '4.16.0', related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}], response : [{name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {}, {}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}], httprequesttype : 'POST'}, {name : 'createRoutingFirewallRule', description : 'Creates a routing firewall rule in the given network in ROUTED mode', since : '4.20.0', isasync : True, related : 'updateIpv6FirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule', params : [{name : 'fordisplay', description : 'an optional field, whether to the display the rule to the end user or not', type : 'boolean', length : 255, required : False}, {name : 'cidrlist', description : 'the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).', type : 'list', length : 255, required : False}, {name : 'icmpcode', description : 'error code for this ICMP message', type : 'integer', length : 255, required : False}, {name : 'traffictype', description : 'the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified', type : 'string', length : 255, required : False}, {name : 'networkid', description : 'The network of the VM the firewall rule will be created for', type : 'uuid', length : 255, required : True, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'endport', description : 'the ending port of firewall rule', type : 'integer', length : 255, required : False}, {name : 'startport', description : 'the starting port of firewall rule', type : 'integer', length : 255, required : False}, {name : 'icmptype', description : 'type of the ICMP message being sent', type : 'integer', length : 255, required : False}, {name : 'protocol', description : 'the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number', type : 'string', length : 255, required : True}, {name : 'destcidrlist', description : 'the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).', type : 'list', length : 255, required : False}], response : [{name : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {name : 'state', description : 'The state of the rule', type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID for the port forwarding rule', type : 'string'}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'The ID of the port forwarding rule', type : 'string'}, {name : 'privateendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'networkid', description : 'The ID of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'list', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'publicport', description : "The starting port of port forwarding rule's public port range", type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', type : 'string'}, {name : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {}, {name : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {name : 'virtualmachinedisplayname', description : 'The Instance display name for the port forwarding rule', type : 'string'}, {}, {name : 'privateport', description : "The starting port of port forwarding rule's private port range", type : 'string'}, {name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}], httprequesttype : 'POST'}, {name : 'listNetworkPermissions', description : 'List Network visibility and all Accounts that have permissions to view this Network.', since : '4.17.0', isasync : False, related : '', params : [{name : 'networkid', description : 'Lists Network permission by Network ID', type : 'uuid', length : 255, required : True, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}], response : [{}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'project', description : 'The project the Network is available for', type : 'string'}, {name : 'domainid', description : 'The ID of the domain to which the Network belongs', type : 'string'}, {name : 'accountid', description : 'The ID of Account the Network is available for', type : 'string'}, {name : 'domain', description : 'The name of the domain to which the Network belongs', type : 'string'}, {name : 'projectid', description : 'The ID of project the Network is available for', type : 'string'}, {name : 'account', description : 'The Account the Network is available for', type : 'string'}, {name : 'networkid', description : 'The Network ID', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'removeVirtualMachineFromBackupOffering', description : 'Removes an Instance from any existing backup offering', since : '4.14.0', isasync : True, params : [{name : 'virtualmachineid', description : 'ID of the  Instance', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}, {name : 'forced', description : 'Whether to force remove Instance from the backup offering that may also delete Instance backups.', type : 'boolean', length : 255, required : False}], response : [{}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'updateResourceSchedule', description : 'Update Resource Schedule', since : '4.23.0', isasync : False, related : '', params : [{name : 'enabled', description : 'Enable or disable the schedule.', type : 'boolean', length : 255, required : False}, {name : 'timezone', description : 'Specifies a timezone for this command.', type : 'string', length : 255, required : False}, {name : 'description', description : 'Description of the schedule', type : 'string', length : 255, required : False}, {name : 'schedule', description : 'Schedule for action on resource in cron format.', type : 'string', length : 255, required : False}, {name : 'details', description : 'Map of (key/value pairs) details for the schedule.', type : 'map', length : 255, required : False}, {name : 'id', description : 'ID of the schedule to be updated', type : 'uuid', length : 255, required : True, related : 'updateResourceSchedule'}, {name : 'startdate', description : 'Start date from which the schedule becomes active.', type : 'date', length : 255, required : False}, {name : 'enddate', description : 'End date after which the schedule becomes inactive.', type : 'date', length : 255, required : False}], response : [{}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'details', description : 'Schedule details', type : 'map'}, {name : 'resourcetype', description : 'Type of the resource', type : 'apicommandresourcetype'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'action', description : 'Action', type : 'action'}, {name : 'schedule', description : 'Cron formatted resource schedule', type : 'string'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {name : 'id', description : 'The ID of resource schedule', type : 'string'}, {name : 'description', description : 'Description of resource schedule', type : 'string'}, {name : 'enabled', description : 'Resource schedule is enabled', type : 'boolean'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'listWebhookDeliveries', description : 'Lists Webhook deliveries', since : '4.20.0', isasync : False, related : 'createWebhook,updateWebhook', params : [{name : 'eventtype', description : 'The event type of the Webhook delivery', type : 'string', length : 255, required : False}, {name : 'enddate', description : 'The end date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having end date equal to or before the specified date will be listed.', type : 'date', length : 255, required : False}, {name : 'managementserverid', description : 'The ID of the management server', type : 'uuid', length : 255, required : False, related : 'listManagementServers'}, {name : 'startdate', description : 'The start date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having start date equal to or after the specified date will be listed.', type : 'date', length : 255, required : False}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the Webhook delivery', type : 'uuid', length : 255, required : False, related : ''}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'description', description : 'The description of the Webhook', type : 'string'}, {name : 'projectid', description : 'the project id of the Kubernetes cluster', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {name : 'secretkey', description : 'The secret key for the Webhook', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Webhook exists', type : 'string'}, {name : 'created', description : 'The date when this Webhook was created', type : 'date'}, {name : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {}, {name : 'project', description : 'the project name of the Kubernetes cluster', type : 'string'}, {name : 'account', description : 'The account associated with the Webhook', type : 'string'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {name : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Webhook exists', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', type : 'string'}], httprequesttype : 'GET'}, {name : 'restartSharedFileSystem', description : 'Restart a Shared FileSystem', since : '4.20.0', isasync : True, params : [{name : 'cleanup', description : 'is cleanup required', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'addVmwareDc', description : 'Adds a VMware datacenter to specified zone', isasync : False, related : '', params : [{name : 'password', description : 'The password for specified username.', type : 'string', length : 255, required : False}, {name : 'vcenter', description : 'The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.', type : 'string', length : 255, required : True}, {name : 'zoneid', description : 'The Zone ID.', type : 'uuid', length : 255, required : True, related : 'createZone,listZones'}, {name : 'name', description : 'Name of VMware datacenter to be added to specified zone.', type : 'string', length : 255, required : True}, {name : 'username', description : 'The Username required to connect to resource.', type : 'string', length : 255, required : False}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'vcenter', description : 'The VMware vCenter name/ip', type : 'string'}, {name : 'name', description : 'The VMware Datacenter name', type : 'string'}, {}, {name : 'id', description : 'The VMware Datacenter ID', type : 'string'}, {name : 'zoneid', description : 'The Zone ID associated with this VMware Datacenter', type : 'long'}], httprequesttype : 'POST'}, {name : 'updateIpv6FirewallRule', description : 'Updates Ipv6 firewall rule with specified ID', isasync : True, related : 'listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule', params : [{name : 'cidrlist', description : 'The cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).', type : 'list', length : 255, required : False}, {name : 'customid', description : 'An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only', type : 'string', length : 255, required : False, since : '4.4'}, {name : 'endport', description : 'The ending port of Ipv6 firewall rule', type : 'integer', length : 255, required : False}, {name : 'fordisplay', description : 'An optional field, whether to the display the Ipv6 firewall rule to the end User or not', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'icmptype', description : 'Type of the ICMP message being sent', type : 'integer', length : 255, required : False}, {name : 'traffictype', description : 'The traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified', type : 'string', length : 255, required : False}, {name : 'startport', description : 'The starting port of Ipv6 firewall rule', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the IPv6 firewall rule', type : 'uuid', length : 255, required : True, related : 'updateIpv6FirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule'}, {name : 'icmpcode', description : 'Error code for this ICMP message', type : 'integer', length : 255, required : False}, {name : 'protocol', description : 'The protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number', type : 'string', length : 255, required : False}], response : [{name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {name : 'privateendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'networkid', description : 'The ID of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'publicport', description : "The starting port of port forwarding rule's public port range", type : 'string'}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID for the port forwarding rule', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'virtualmachinedisplayname', description : 'The Instance display name for the port forwarding rule', type : 'string'}, {name : 'state', description : 'The state of the rule', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'list', response : [{name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {name : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}, {name : 'id', description : 'The ID of the port forwarding rule', type : 'string'}, {name : 'privateport', description : "The starting port of port forwarding rule's private port range", type : 'string'}, {name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {}, {}], httprequesttype : 'POST'}, {name : 'getVMPassword', description : 'Returns an encrypted password for the Instance', isasync : False, related : '', params : [{name : 'id', description : 'The ID of the Instance', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm'}], response : [{name : 'encryptedpassword', description : 'The base64 encoded encrypted password of the Instance', type : 'string'}, {}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'listAutoScaleVmGroups', description : 'Lists autoscale Instance groups.', isasync : False, related : 'enableAutoScaleVmGroup', params : [{name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'The name of the autoscale vmgroup', type : 'string', length : 255, required : False, since : '4.18.0'}, {name : 'lbruleid', description : 'The ID of the loadbalancer', type : 'uuid', length : 255, required : False, related : 'listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'policyid', description : 'The ID of the policy', type : 'uuid', length : 255, required : False, related : 'listAutoScalePolicies'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the autoscale Instance group', type : 'uuid', length : 255, required : False, related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'activateProject,createProject'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'fordisplay', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'zoneid', description : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'vmprofileid', description : 'The ID of the profile', type : 'uuid', length : 255, required : False, related : 'createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile'}], response : [{name : 'publicipid', description : 'The public IP address ID', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {name : 'minmembers', description : 'The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.', type : 'int'}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'associatednetworkname', description : 'The name of the guest Network the LB rule belongs to', type : 'string'}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'maxmembers', description : 'The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.', type : 'int'}, {name : 'privateport', description : 'The private port', type : 'string'}, {name : 'publicip', description : 'The public IP address', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the vm group belongs', type : 'string'}, {name : 'project', description : 'The project name of the Instance group', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance group', type : 'string'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'created', description : 'The date when this Instance group was created', type : 'date'}, {name : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {name : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'lbprovider', description : 'The LB provider of the guest Network the LB rule belongs to', type : 'string'}, {name : 'projectid', description : 'The project id of the Instance group', type : 'string'}, {name : 'state', description : 'The current state of the AutoScale Instance Group', type : 'string'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'publicport', description : 'The public port', type : 'string'}], httprequesttype : 'GET'}, {name : 'registerUserData', description : 'Register a new User Data.', since : '4.18', isasync : False, params : [{name : 'projectid', description : 'an optional project for the user data', type : 'uuid', length : 255, required : False, related : 'activateProject,createProject'}, {name : 'domainid', description : 'an optional domainId for the user data. If the account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'account', description : 'an optional account for the user data. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'userdata', description : 'Base64 encoded User Data content. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 32KB of data after base64 encoding, which can be increased upto 1MB using the vm.userdata.max.length setting', type : 'string', length : 1048576, required : True}, {name : 'params', description : 'comma separated list of variables declared in user data content', type : 'string', length : 255, required : False}, {name : 'name', description : 'Name of the user data', type : 'string', length : 255, required : True}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'listAccounts', description : 'Lists Accounts and provides detailed Account information for listed Accounts', isasync : False, related : 'disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts', params : [{name : 'tag', description : 'Tag for resource type to return usage', type : 'string', length : 255, required : False, since : '4.20.0'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'iscleanuprequired', description : 'List accounts by cleanuprequired attribute (values are true or false)', type : 'boolean', length : 255, required : False}, {name : 'state', description : 'List accounts by state. Valid states are enabled, disabled, and locked.', type : 'string', length : 255, required : False}, {name : 'accounttype', description : 'List Accounts by Account type. Valid Account types are 1 (admin), 2 (domain-admin), and 0 (user).', type : 'integer', length : 255, required : False}, {name : 'showicon', description : 'Flag to display the resource icon for accounts', type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'List Account by Account ID', type : 'uuid', length : 255, required : False, related : 'disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts'}, {name : 'details', description : 'Comma separated list of account details requested, value can be a list of [ all, resource, min]', type : 'list', length : 255, required : False}, {name : 'apikeyaccess', description : 'List accounts by the Api key access value', type : 'string', length : 255, required : False, since : '4.20.1.0'}, {name : 'name', description : 'List account by account name', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}], response : [{name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'name', description : 'The name of the Account', type : 'string'}, {name : 'backupavailable', description : 'the total number of backups available to this account', type : 'string'}, {name : 'cpulimit', description : 'The total number of CPU cores the account can own', type : 'string'}, {name : 'templateavailable', description : 'The total number of Templates available to be created by this Account', type : 'string'}, {name : 'vmlimit', description : 'The total number of Instances that can be deployed by this Account', type : 'string'}, {name : 'id', description : 'The ID of the Account', type : 'string'}, {name : 'vmrunning', description : 'The total number of Instances running for this Account', type : 'integer'}, {name : 'roletype', description : 'The type of the role (Admin, ResourceAdmin, DomainAdmin, User)', type : 'string'}, {name : 'vpcavailable', description : 'The total number of VPCs available to be created for this account', type : 'string'}, {name : 'bucketavailable', description : 'the total number of buckets available to this account', type : 'string'}, {name : 'primarystoragelimit', description : 'The total primary storage space (in GiB) the account can own', type : 'string'}, {name : 'networktotal', description : 'The total number of Networks owned by Account', type : 'long'}, {name : 'projecttotal', description : 'The total number of projects being administrated by this Account', type : 'long'}, {name : 'snapshotavailable', description : 'The total number of Snapshots available for this Account', type : 'string'}, {name : 'user', description : 'The list of users associated with account', type : 'list', response : [{name : 'is2famandated', description : 'True if user has two factor authentication is mandated', type : 'boolean'}, {name : 'apikey', description : 'The API key of the user', type : 'string'}, {name : 'isdefault', description : 'True if user is default, false otherwise', type : 'boolean'}, {name : 'apikeyaccess', description : 'Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)', type : 'apikeyaccess'}, {name : 'accounttype', description : 'The Account type of the user', type : 'integer'}, {name : 'lastname', description : 'The user lastname', type : 'string'}, {name : 'roleid', description : 'The ID of the role', type : 'string'}, {name : 'timezone', description : 'The timezone user was created in', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'accountid', description : 'The Account ID of the user', type : 'string'}, {name : 'roletype', description : 'The type of the role', type : 'string'}, {name : 'is2faenabled', description : 'True if user has two factor authentication enabled', type : 'boolean'}, {name : 'secretkey', description : 'The secret key of the user', type : 'string'}, {name : 'username', description : 'The user name', type : 'string'}, {name : 'state', description : 'The user state', type : 'string'}, {name : 'usersource', description : 'The source type of the user in lowercase, such as native, ldap, saml2', type : 'string'}, {name : 'iscallerchilddomain', description : "The boolean value representing if the updating target is in caller's child domain", type : 'boolean'}, {name : 'email', description : 'The user email address', type : 'string'}, {name : 'id', description : 'The user ID', type : 'string'}, {name : 'domainid', description : 'The domain ID of the user', type : 'string'}, {name : 'firstname', description : 'The user firstname', type : 'string'}, {name : 'created', description : 'The date and time the user Account was created', type : 'date'}, {name : 'domain', description : 'The domain name of the user', type : 'string'}, {name : 'account', description : 'The Account name of the user', type : 'string'}, {name : 'rolename', description : 'The name of the role', type : 'string'}]}, {name : 'templatelimit', description : 'The total number of Templates which can be created by this Account', type : 'string'}, {name : 'bucketlimit', description : 'the total number of buckets which can be stored by this account', type : 'string'}, {name : 'networklimit', description : 'The total number of Networks the Account can own', type : 'string'}, {name : 'vmstopped', description : 'The total number of Instances stopped for this Account', type : 'integer'}, {name : 'iptotal', description : 'The total number of public IP addresses allocated for this Account', type : 'long'}, {name : 'rolename', description : 'The name of the role', type : 'string'}, {name : 'created', description : 'The date when this account was created', type : 'date'}, {name : 'apikeyaccess', description : 'whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)', type : 'apikeyaccess'}, {name : 'objectstorageavailable', description : 'the total object storage space (in GiB) available to the account', type : 'string'}, {name : 'vmtotal', description : 'The total number of Instances deployed by this Account', type : 'long'}, {name : 'secondarystoragelimit', description : 'The total secondary storage space (in GiB) the account can own', type : 'string'}, {name : 'isdefault', description : 'True if account is default, false otherwise', type : 'boolean'}, {name : 'backuptotal', description : 'the total number of backups stored by this account', type : 'long'}, {name : 'ipavailable', description : 'The total number of public IP addresses available for this Account to acquire', type : 'string'}, {name : 'snapshottotal', description : 'The total number of Snapshots stored by this Account', type : 'long'}, {name : 'gpuavailable', description : 'the total number of gpus available to be created for this account', type : 'string'}, {name : 'domainid', description : 'ID of the Domain the Account belongs to', type : 'string'}, {name : 'accountdetails', description : 'Details for the account', type : 'map'}, {name : 'iplimit', description : 'The total number of public IP addresses this Account can acquire', type : 'string'}, {name : 'vpctotal', description : 'The total number of VPCs owned by account', type : 'long'}, {name : 'snapshotlimit', description : 'The total number of Snapshots which can be stored by this Account', type : 'string'}, {name : 'vpclimit', description : 'The total number of VPCs the Account can own', type : 'string'}, {name : 'defaultzoneid', description : 'The default zone of the Account', type : 'string'}, {name : 'taggedresources', description : 'The tagged resource limit and count for the account', type : 'list'}, {name : 'cputotal', description : 'The total number of CPU cores owned by account', type : 'long'}, {name : 'volumeavailable', description : 'The total volume available for this Account', type : 'string'}, {name : 'memoryavailable', description : 'The total memory (in MB) available to be created for this account', type : 'string'}, {name : 'networkdomain', description : 'The Network domain', type : 'string'}, {}, {name : 'domainpath', description : 'Path of the Domain the Account belongs to', type : 'string'}, {name : 'volumelimit', description : 'The total volume which can be used by this Account', type : 'string'}, {name : 'secondarystoragetotal', description : 'The total secondary storage space (in GiB) owned by account', type : 'float'}, {name : 'buckettotal', description : 'the total number of buckets stored by this account', type : 'long'}, {name : 'backuplimit', description : 'the total number of backups which can be stored by this account', type : 'string'}, {name : 'roleid', description : 'The ID of the role', type : 'string'}, {name : 'networkavailable', description : 'The total number of Networks available to be created for this Account', type : 'string'}, {name : 'projectlimit', description : 'The total number of projects the Account can own', type : 'string'}, {name : 'volumetotal', description : 'The total volume being used by this Account', type : 'long'}, {name : 'secondarystorageavailable', description : 'The total secondary storage space (in GiB) available to be used for this account', type : 'string'}, {name : 'backupstoragetotal', description : 'the total backup storage space (in GiB) owned by the account', type : 'long'}, {name : 'gpulimit', description : 'the total number of gpus the account can own', type : 'string'}, {name : 'backupstoragelimit', description : 'the total backup storage space (in GiB) the account can own', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'templatetotal', description : 'The total number of Templates which have been created by this Account', type : 'long'}, {name : 'objectstoragelimit', description : 'the total object storage space (in GiB) the account can own', type : 'string'}, {name : 'state', description : 'The state of the account', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'cpuavailable', description : 'The total number of CPU cores available to be created for this account', type : 'string'}, {name : 'accounttype', description : 'Account type (admin, domain-admin, user)', type : 'integer'}, {name : 'projectavailable', description : 'The total number of projects available for administration by this Account', type : 'string'}, {name : 'vmavailable', description : 'The total number of Instances available for this Account to acquire', type : 'string'}, {name : 'primarystorageavailable', description : 'The total primary storage space (in GiB) available to be used for this account', type : 'string'}, {name : 'gputotal', description : 'the total number of gpus owned by account', type : 'long'}, {name : 'iscleanuprequired', description : 'True if the account requires cleanup', type : 'boolean'}, {name : 'backupstorageavailable', description : 'the total backup storage space (in GiB) available to the account', type : 'string'}, {name : 'objectstoragetotal', description : 'the total object storage space (in GiB) owned by the account', type : 'long'}, {}, {name : 'domain', description : 'Name of the Domain the Account belongs to', type : 'string'}, {name : 'memorytotal', description : 'The total memory (in MB) owned by account', type : 'long'}, {name : 'primarystoragetotal', description : 'The total primary storage space (in GiB) owned by account', type : 'long'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'memorylimit', description : 'The total memory (in MB) the account can own', type : 'string'}, {name : 'groups', description : 'The list of ACL groups that account belongs to', type : 'list'}], httprequesttype : 'GET'}, {name : 'deleteDnsZone', description : 'Removes a DNS Zone from CloudStack and the external provider', since : '4.23.0', isasync : True, params : [{name : 'unmanage', description : 'If true, removes the DNS zone only from CloudStack; if false, removes it from both CloudStack and the DNS provider. Default: false', type : 'boolean', length : 255, required : False, related : 'listDnsZones'}, {name : 'id', description : 'The ID of the DNS zone', type : 'uuid', length : 255, required : True, related : 'listDnsZones'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'createAutoScaleVmProfile', description : 'Creates a profile that contains information about the Instance which will be provisioned automatically by autoscale feature.', isasync : True, related : 'listAutoScaleVmProfiles,updateAutoScaleVmProfile', params : [{name : 'domainid', description : 'Domain ID of the Account owning an autoscale Instance profile', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'userdatadetails', description : 'used to specify the parameters values for the variables in userdata.', type : 'map', length : 255, required : False, since : '4.18.1'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is expunged', type : 'integer', length : 255, required : False}, {name : 'zoneid', description : 'Availability zone for the auto deployed Instance', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'account', description : 'Account that will own the autoscale Instance profile', type : 'string', length : 255, required : False}, {name : 'counterparam', description : 'counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161', type : 'map', length : 255, required : False}, {name : 'projectid', description : 'An optional project for the autoscale Instance profile', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'templateid', description : 'The Template of the auto deployed Instance', type : 'uuid', length : 255, required : True, related : 'prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'autoscaleuserid', description : 'The ID of the user used to launch and destroy the Instances', type : 'uuid', length : 255, required : False, related : 'disableUser,getUser,listUsers,lockUser'}, {name : 'serviceofferingid', description : 'The service offering of the auto deployed Instance', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId of the auto deployed  Instance.\nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids\'" and "networkids".', type : 'map', length : 255, required : False}, {name : 'fordisplay', description : 'An optional field, whether to the display the profile to the end user or not', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'userdataid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.18.1', related : 'listCniConfiguration'}, {name : 'userdata', description : 'An optional binary data that can be sent to the Instance upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value', type : 'string', length : 1048576, required : False, since : '4.18.0'}], response : [{}, {name : 'fordisplay', description : 'Is profile for display to the regular User', type : 'boolean'}, {}, {name : 'project', description : 'The project name of the Instance profile', type : 'string'}, {name : 'userdata', description : 'Base64 encoded Instance user data', type : 'string'}, {name : 'id', description : 'The autoscale Instance profile ID', type : 'string'}, {name : 'zoneid', description : 'The availability zone to be used while deploying an Instance', type : 'string'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer'}, {name : 'userdatadetails', description : 'list of variables and values for the variables declared in userdata', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'templateid', description : 'The Template to be used while deploying an Instance', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the vm profile belongs', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance profile', type : 'string'}, {name : 'userdatapolicy', description : 'the userdata override policy with the userdata provided while deploying VM', type : 'string'}, {name : 'projectid', description : 'The project id Instance profile', type : 'string'}, {name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance', type : 'map'}, {name : 'userdataname', description : 'the name of userdata used for the VM', type : 'string'}, {name : 'userdataid', description : 'the id of userdata used for the VM', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance profile', type : 'string'}, {}, {name : 'autoscaleuserid', description : 'The ID of the User used to launch and destroy the Instances', type : 'string'}, {name : 'serviceofferingid', description : 'The service offering to be used while deploying an Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], httprequesttype : 'POST'}, {name : 'deleteVnfTemplate', description : 'Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected.', since : '4.19.0', isasync : True, params : [{name : 'forced', description : 'Force delete a Template.', type : 'boolean', length : 255, required : False, since : '4.9+'}, {name : 'id', description : 'The ID of the Template', type : 'uuid', length : 255, required : True, related : 'prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'issystem', description : "Necessary if the template's type is system.", type : 'boolean', length : 255, required : False, since : '4.20.0'}, {name : 'zoneid', description : 'The ID of zone of the Template', type : 'uuid', length : 255, required : False, related : 'listZones'}], response : [{}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'updateBackupSchedule', description : 'Updates a User-defined Instance backup schedule', since : '4.14.0', isasync : False, related : '', params : [{name : 'schedule', description : 'Custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28)', type : 'string', length : 255, required : True}, {name : 'intervaltype', description : 'Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY', type : 'string', length : 255, required : True}, {name : 'virtualmachineid', description : 'ID of the Instance for which schedule is to be defined', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'isolated', description : 'Whether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.', type : 'boolean', length : 255, required : False, since : '4.23.0'}, {name : 'quiescevm', description : 'Quiesce the Instance before checkpointing the disks for backup. Applicable only to NAS and KBOSS backup providers. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'timezone', description : 'Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.', type : 'string', length : 255, required : True}, {name : 'maxbackups', description : 'The maximum number of backups to keep for a VM. If "0", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.', type : 'integer', length : 255, required : False, since : '4.21.0'}], response : [{name : 'name', description : 'name of the backup', type : 'string'}, {name : 'validationstatus', description : 'Backup validation status.', type : 'validationstatus'}, {name : 'domain', description : 'Domain name', type : 'string'}, {name : 'accountid', description : 'Account id', type : 'string'}, {name : 'account', description : 'Account name', type : 'string'}, {name : 'domainid', description : 'Domain ID', type : 'string'}, {name : 'fromcheckpointid', description : 'Previous active checkpoint ID for incremental backups', type : 'string'}, {name : 'hostid', description : 'Host ID where the backup is running', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zone', description : 'Zone name', type : 'string'}, {name : 'virtualsize', description : 'Backup protected (virtual) size in bytes', type : 'long'}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'type', description : 'Backup type', type : 'string'}, {name : 'isbackupvmexpunged', description : 'Indicates whether the VM from which the backup was taken is expunged or not', type : 'boolean'}, {name : 'description', description : 'description for the backup', type : 'string'}, {name : 'backupofferingname', description : 'Backup offering name', type : 'string'}, {name : 'id', description : 'ID of the Instance backup', type : 'string'}, {name : 'volumes', description : 'Backed up volumes', type : 'string'}, {name : 'vmbackupofferingremoved', description : 'The backup offering corresponding to this backup was removed from the VM', type : 'boolean'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'created', description : 'Backup date', type : 'date'}, {name : 'intervaltype', description : 'Interval type of the backup', type : 'string'}, {name : 'status', description : 'Backup status', type : 'status'}, {name : 'externalid', description : 'External backup id', type : 'string'}, {name : 'size', description : 'Backup size in bytes', type : 'long'}, {name : 'uncompressedsize', description : 'Backup uncompressed size in bytes. Only defined if backup is compressed.', type : 'long'}, {name : 'compressionstatus', description : 'Backup compression status.', type : 'compressionstatus'}, {name : 'backupofferingid', description : 'Backup offering id', type : 'string'}, {name : 'vmdetails', description : 'Lists the vm specific details for the backup', type : 'map'}, {name : 'tocheckpointid', description : 'Next checkpoint ID for incremental backups', type : 'string'}], httprequesttype : 'POST'}, {name : 'createPrivateGateway', description : 'Creates a private gateway', since : '4.17.0', isasync : True, related : 'createPrivateGateway,listPrivateGateways', params : [{name : 'physicalnetworkid', description : 'The Physical Network ID the network belongs to', type : 'uuid', length : 255, required : False, related : 'listPhysicalNetworks,updatePhysicalNetwork'}, {name : 'bypassvlanoverlapcheck', description : 'When true bypasses VLAN id/range overlap check during private gateway creation', type : 'boolean', length : 255, required : False}, {name : 'netmask', description : 'The Netmask of the Private Gateway', type : 'string', length : 255, required : True}, {name : 'vpcid', description : 'The VPC Network belongs to', type : 'uuid', length : 255, required : True, related : 'listVPCs,createVPC,listVPCs,updateVPC'}, {name : 'gateway', description : 'The Gateway of the Private Gateway', type : 'string', length : 255, required : True}, {name : 'sourcenatsupported', description : "Source NAT supported value. Default value: false. When 'true', the source NAT is enabled on the private gateway 'false': sourcenat is not supported", type : 'boolean', length : 255, required : False}, {name : 'ipaddress', description : 'The IP address of the Private Gateway', type : 'string', length : 255, required : True}, {name : 'vlan', description : 'The network implementation uri for the private gateway', type : 'string', length : 255, required : False}, {name : 'networkofferingid', description : 'The UUID of the Network offering to use for the private gateways Network connection', type : 'uuid', length : 255, required : False, related : 'createNetworkOffering,updateNetworkOffering,listNetworkOfferings'}, {name : 'aclid', description : 'The ID of the Network ACL', type : 'uuid', length : 255, required : False, related : 'createNetworkACLList,listNetworkACLLists'}, {name : 'associatednetworkid', description : 'The Isolated Network this private gateway is associated to.', type : 'uuid', length : 255, required : False, since : '4.17.0', related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}], response : [{name : 'vpcid', description : 'VPC ID the private gateway belongs to', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'aclname', description : 'ACL name set for private gateway', type : 'string'}, {name : 'netmask', description : "The private gateway's netmask", type : 'string'}, {name : 'vlan', description : 'The Network implementation uri for the private gateway', type : 'string'}, {name : 'id', description : 'The ID of the private gateway', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'state', description : 'State of the gateway, can be Creating, Ready, Deleting', type : 'string'}, {name : 'project', description : 'The project name of the private gateway', type : 'string'}, {name : 'sourcenatsupported', description : 'Source Nat enable status', type : 'boolean'}, {name : 'ipaddress', description : "The private gateway's IP address", type : 'string'}, {name : 'associatednetworkid', description : 'The ID of the Network associated with this private gateway', type : 'string'}, {name : 'zoneid', description : 'Zone ID of the private gateway', type : 'string'}, {name : 'vpcname', description : 'VPC name the private gateway belongs to', type : 'string'}, {}, {name : 'aclid', description : 'ACL ID set for private gateway', type : 'string'}, {name : 'domain', description : 'The domain associated with the private gateway', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'projectid', description : 'The project ID of the private gateway', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the private gateway belongs', type : 'string'}, {name : 'gateway', description : 'The gateway', type : 'string'}, {name : 'associatednetwork', description : 'The name of the Network associated with this private gateway', type : 'string'}, {name : 'physicalnetworkid', description : 'The physical Network id', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the private gateway', type : 'string'}, {name : 'zonename', description : 'The name of the zone the private gateway belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the private gateway', type : 'string'}], httprequesttype : 'POST'}, {name : 'createVMFromBackup', description : 'Creates and automatically starts a VM from a backup.', since : '4.21.0', isasync : True, related : 'assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm', params : [{name : 'clusterid', description : 'destination Cluster ID to deploy the VM to - parameter available for root admin only', type : 'uuid', length : 255, required : False, since : '4.21', related : 'addCluster,updateCluster'}, {name : 'hypervisor', description : 'the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call', type : 'string', length : 255, required : False}, {name : 'ip6address', description : "the ipv6 address for default vm's network", type : 'string', length : 255, required : False}, {name : 'domainid', description : 'an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'zoneid', description : 'availability zone for the virtual machine', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'projectid', description : 'Deploy vm for the project', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'extraconfig', description : 'an optional URL encoded string that can be passed to the virtual machine upon successful deployment', type : 'string', length : 5120, required : False, since : '4.12'}, {name : 'password', description : 'The password of the virtual machine. If null, a random password will be generated for the VM.', type : 'string', length : 255, required : False, since : '4.19.0.0'}, {name : 'backupid', description : 'backup ID to create the VM from', type : 'uuid', length : 255, required : True, related : ''}, {name : 'customid', description : 'An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only', type : 'string', length : 255, required : False}, {name : 'nicpackedvirtqueuesenabled', description : 'Enable packed virtqueues or not.', type : 'boolean', length : 255, required : False, since : '4.18'}, {name : 'size', description : 'the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId', type : 'long', length : 255, required : False}, {name : 'keypair', description : 'name of the ssh key pair used to login to the virtual machine', type : 'string', length : 255, required : False}, {name : 'userdata', description : 'an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value', type : 'string', length : 1048576, required : False}, {name : 'dynamicscalingenabled', description : 'true if virtual machine needs to be dynamically scalable', type : 'boolean', length : 255, required : False, since : '4.16'}, {name : 'leaseduration', description : 'Number of days instance is leased for.', type : 'integer', length : 255, required : False, since : '4.21.0'}, {name : 'macaddress', description : "the mac address for default vm's network", type : 'string', length : 255, required : False}, {name : 'preserveip', description : 'Use the same IP/MAC addresses as stored in the backup metadata. Works only if the original Instance is deleted and the IP/MAC address is available.', type : 'boolean', length : 255, required : False}, {name : 'userdatadetails', description : 'used to specify the parameters values for the variables in userdata.', type : 'map', length : 255, required : False, since : '4.18'}, {name : 'keypairs', description : 'names of the ssh key pairs used to login to the virtual machine', type : 'list', length : 255, required : False, since : '4.17'}, {name : 'datadiskofferinglist', description : "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", type : 'map', length : 255, required : False, since : '4.11'}, {name : 'bootmode', description : 'Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.', type : 'string', length : 255, required : False, since : '4.14.0.0'}, {name : 'details', description : "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", type : 'map', length : 255, required : False, since : '4.3'}, {name : 'hostid', description : 'destination Host ID to deploy the VM to - parameter available for root admin only', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,listHosts,reconnectHost'}, {name : 'rootdisksize', description : 'Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided', type : 'long', length : 255, required : False, since : '4.4'}, {name : 'rootdiskkmskeyid', description : 'ID of the KMS Key to use for root disk encryption', type : 'uuid', length : 255, required : False, since : '4.23.0', related : 'createKMSKey,updateKMSKey'}, {name : 'bootintosetup', description : 'Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)', type : 'boolean', length : 255, required : False, since : '4.15.0.0'}, {name : 'keyboard', description : 'an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,es-latam,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us', type : 'string', length : 255, required : False}, {name : 'iothreadsenabled', description : 'IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.', type : 'boolean', length : 255, required : False}, {name : 'networkids', description : "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", type : 'list', length : 255, required : False, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}, {name : 'displayvm', description : 'an optional field, whether to the display the vm to the end user or not.', type : 'boolean', length : 255, required : False, since : '4.2'}, {name : 'copyimagetags', description : 'if true the image tags (if any) will be copied to the VM, default value is false', type : 'boolean', length : 255, required : False, since : '4.13'}, {name : 'ipaddress', description : "the ip address for default vm's network", type : 'string', length : 255, required : False}, {name : 'properties', description : 'used to specify the vApp properties.', type : 'map', length : 255, required : False, since : '4.15'}, {name : 'nicmultiqueuenumber', description : 'The number of queues for multiqueue NICs.', type : 'integer', length : 255, required : False, since : '4.18'}, {name : 'group', description : 'an optional group for the virtual machine', type : 'string', length : 255, required : False}, {name : 'securitygroupnames', description : 'comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter', type : 'list', length : 255, required : False, related : 'updateSecurityGroup'}, {name : 'leaseexpiryaction', description : 'Lease expiry action, valid values are STOP and DESTROY', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'affinitygroupids', description : 'comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter', type : 'list', length : 255, required : False, related : 'createAffinityGroup,listAffinityGroups'}, {name : 'externaldetails', description : 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'securitygroupids', description : 'comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter', type : 'list', length : 255, required : False, related : 'updateSecurityGroup'}, {name : 'boottype', description : 'Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.', type : 'string', length : 255, required : False, since : '4.14.0.0'}, {name : 'iptonetworklist', description : "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", type : 'map', length : 255, required : False}, {name : 'dhcpoptionsnetworklist', description : 'DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com', type : 'map', length : 255, required : False}, {name : 'iodriverpolicy', description : 'Controls specific policies on IO', type : 'string', length : 255, required : False}, {name : 'userdataid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.18', related : 'listCniConfiguration'}, {name : 'account', description : 'an optional account for the virtual machine. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'templateid', description : 'the ID of the template for the virtual machine', type : 'uuid', length : 255, required : False, related : 'prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'startvm', description : 'true if start vm after creating; defaulted to true if not specified', type : 'boolean', length : 255, required : False}, {name : 'deploymentplanner', description : 'Deployment planner to use for vm allocation. Available to ROOT admin only', type : 'string', length : 255, required : False, since : '4.4'}, {name : 'podid', description : 'destination Pod ID to deploy the VM to - parameter available for root admin only', type : 'uuid', length : 255, required : False, since : '4.21', related : 'createPod,listPods,createManagementNetworkIpRange'}, {name : 'quickrestore', description : 'Whether to use the quick restore process or not. Currently this parameter is only supported by the KBOSS provider.', type : 'boolean', length : 255, required : False, since : '4.23.0', related : ''}, {name : 'name', description : 'host name for the virtual machine', type : 'string', length : 255, required : False}, {name : 'affinitygroupnames', description : 'comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter', type : 'list', length : 255, required : False, related : 'createAffinityGroup,listAffinityGroups'}, {name : 'nicnetworklist', description : 'VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid', type : 'map', length : 255, required : False, since : '4.15'}, {name : 'datadisksdetails', description : 'Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200&datadisksdetails[0].kmskeyid=<uuid>', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'displayname', description : 'an optional user generated name for the virtual machine', type : 'string', length : 255, required : False}, {name : 'serviceofferingid', description : 'the ID of the service offering for the virtual machine', type : 'uuid', length : 255, required : False, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'diskofferingid', description : 'the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'overridediskofferingid', description : 'the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id', type : 'uuid', length : 255, required : False, since : '4.17', related : ''}], response : [{name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}]}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}]}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}]}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}]}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}]}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}]}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'id', description : 'The ID of the attached ISO', type : 'string'}]}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {}], httprequesttype : 'POST'}, {name : 'updateVMSchedule', description : 'Update Instance Schedule.', since : '4.19.0', isasync : False, related : '', params : [{name : 'startdate', description : 'Start date from which the schedule becomes active(Format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'schedule', description : "Schedule for action on Instance in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", type : 'string', length : 255, required : False}, {name : 'description', description : 'Name of the schedule', type : 'string', length : 255, required : False}, {name : 'enddate', description : 'End date after which the schedule becomes inactive(Format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'timezone', description : 'Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.', type : 'string', length : 255, required : False}, {name : 'enabled', description : 'Enable Instance schedule', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'ID of Instance schedule', type : 'uuid', length : 255, required : True, related : 'updateVMSchedule'}], response : [{name : 'action', description : 'Action', type : 'action'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'virtualmachineid', description : 'ID of Instance', type : 'string'}, {name : 'schedule', description : 'Cron formatted Instance schedule', type : 'string'}, {}, {name : 'description', description : 'Description of Instance schedule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'enabled', description : 'VM schedule is enabled', type : 'boolean'}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'id', description : 'The ID of Instance schedule', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'listGpuDevices', description : 'Lists all available GPU devices', since : '4.21.0', isasync : False, related : 'listGpuDevices,discoverGpuDevices,createGpuDevice', params : [{name : 'id', description : 'ID of the GPU device', type : 'uuid', length : 255, required : False, related : 'listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'virtualmachineid', description : 'the virtual machine ID to which the GPU device is allocated', type : 'uuid', length : 255, required : False, related : 'assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'gpucardid', description : 'the GPU card ID associated with the GPU device', type : 'uuid', length : 255, required : False, related : 'listGpuCards'}, {name : 'hostid', description : 'the host ID where the GPU device is attached', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,listHosts,reconnectHost'}, {name : 'vgpuprofileid', description : 'the vGPU profile ID assigned to the GPU device', type : 'uuid', length : 255, required : False, related : 'createVgpuProfile,updateVgpuProfile'}], response : [{name : 'virtualmachineid', description : 'the vGPU profile ID assigned to this GPU device', type : 'string'}, {name : 'numanode', description : 'the NUMA node where the GPU device is located', type : 'string'}, {name : 'managedstate', description : 'the managed state of the GPU device (Enabled/Disabled)', type : 'managedstate'}, {name : 'gpucardname', description : 'the GPU card name associated with this GPU device', type : 'string'}, {name : 'vgpuprofileid', description : 'the vGPU profile ID assigned to this GPU device', type : 'string'}, {name : 'virtualmachinename', description : 'the vGPU profile name assigned to this GPU device', type : 'string'}, {name : 'gpudevicetype', description : 'bus address of the GPU device', type : 'devicetype'}, {name : 'state', description : 'the vGPU profile name assigned to this GPU device', type : 'state'}, {name : 'vmstate', description : 'the state of the virtual machine to which this GPU device is allocated', type : 'state'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'the ID of the GPU device', type : 'string'}, {}, {name : 'busaddress', description : 'bus address of the GPU device or MDEV UUID for vGPU devices', type : 'string'}, {name : 'hostid', description : 'the host ID where the GPU device is attached', type : 'string'}, {name : 'gpucardid', description : 'the GPU card ID associated with this GPU device', type : 'string'}, {name : 'parentgpudeviceid', description : 'the ID of the parent GPU device, if this is a vGPU', type : 'string'}, {}, {name : 'hostname', description : 'the host name where the GPU device is attached', type : 'string'}, {name : 'vgpuprofilename', description : 'the vGPU profile name assigned to this GPU device', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'assignVirtualMachineToBackupOffering', description : 'Assigns an Instance to a backup offering', since : '4.14.0', isasync : True, params : [{name : 'virtualmachineid', description : 'ID of the  Instance', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'backupofferingid', description : 'ID of the backup offering', type : 'uuid', length : 255, required : True, related : 'listBackupOfferings,updateBackupOffering,createBackupOffering'}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'listResourceIcon', description : 'Lists the resource icon for the specified resource(s)', since : '4.16.0.0', isasync : False, related : '', params : [{name : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : True}, {name : 'resourceids', description : 'List of resources to upload the icon/image for', type : 'list', length : 255, required : True}], response : [{name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'base64image', description : 'Base64 representation of resource icon', type : 'string'}, {}, {name : 'resourcetype', description : 'Resource type', type : 'resourceobjecttype'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'listVirtualMachinesMetrics', description : 'Lists VM metrics', isasync : False, related : 'listVirtualMachinesMetrics', params : [{name : 'keypair', description : 'List Instances by SSH keypair name', type : 'string', length : 255, required : False}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'securitygroupid', description : 'The security group ID', type : 'uuid', length : 255, required : False, since : '4.15', related : 'updateSecurityGroup'}, {name : 'vpcid', description : 'List Instances by VPC', type : 'uuid', length : 255, required : False, related : 'listVPCs,createVPC,listVPCs,updateVPC'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string', length : 255, required : False, since : '4.20.1'}, {name : 'affinitygroupid', description : 'List Instances by affinity group', type : 'uuid', length : 255, required : False, related : 'createAffinityGroup,listAffinityGroups'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'name', description : 'Name of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'isvnf', description : 'flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.', type : 'boolean', length : 255, required : False, since : '4.19.0'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'extensionid', description : 'The ID of the Orchestrator extension for the VM', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension'}, {name : 'hypervisor', description : 'The target hypervisor for the Template', type : 'string', length : 255, required : False}, {name : 'hostid', description : 'The host ID', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,listHosts,reconnectHost'}, {name : 'accumulate', description : 'Accumulates the Instance metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.', type : 'boolean', length : 255, required : False, since : '4.17.0'}, {name : 'userdata', description : "Whether to return the Instances' User data or not. By default, User data will not be returned.", type : 'boolean', length : 255, required : False, since : '4.18.0.0'}, {name : 'leased', description : 'Whether to return only leased instances', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'autoscalevmgroupid', description : 'The ID of AutoScaling Instance Group', type : 'uuid', length : 255, required : False, since : '4.18.0', related : 'enableAutoScaleVmGroup'}, {name : 'id', description : 'The ID of the Instance', type : 'uuid', length : 255, required : False, related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'backupofferingid', description : 'List by the backup offering', type : 'uuid', length : 255, required : False, since : '4.17', related : 'listBackupOfferings,updateBackupOffering,createBackupOffering'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'groupid', description : 'The group ID', type : 'uuid', length : 255, required : False, related : 'updateInstanceGroup'}, {name : 'state', description : 'State of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.', type : 'string', length : 255, required : False}, {name : 'details', description : 'Comma separated list of Instance details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.', type : 'list', length : 255, required : False}, {name : 'forvirtualnetwork', description : 'List by Network type; true if need to list Instances using Virtual Network, false otherwise', type : 'boolean', length : 255, required : False}, {name : 'gpuenabled', description : 'Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'showicon', description : 'Flag to display the resource icon for Instances', type : 'boolean', length : 255, required : False, since : '4.16.0.0'}, {name : 'displayvm', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'storageid', description : "The storage ID where vm's volumes belong to", type : 'uuid', length : 255, required : False, related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}, {name : 'zoneid', description : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'haenable', description : 'List by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabled', type : 'boolean', length : 255, required : False, since : '4.15'}, {name : 'templateid', description : 'List Instances by Template', type : 'uuid', length : 255, required : False, related : 'prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'ids', description : 'The IDs of the Instances, mutually exclusive with id', type : 'list', length : 255, required : False, since : '4.4', related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'userid', description : 'The user ID that created the Instance and is under the Account that owns the Instance', type : 'uuid', length : 255, required : False, related : 'disableUser,getUser,listUsers,lockUser'}, {name : 'isoid', description : 'List Instances by ISO', type : 'uuid', length : 255, required : False}, {name : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}, {name : 'podid', description : 'The pod ID', type : 'uuid', length : 255, required : False, related : 'listPods,createManagementNetworkIpRange'}, {name : 'clusterid', description : 'The cluster ID', type : 'uuid', length : 255, required : False, related : 'addCluster,updateCluster'}, {name : 'serviceofferingid', description : 'List by the service offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", type : 'boolean', length : 255, required : False}, {name : 'userdataid', description : 'the instances by userdata', type : 'uuid', length : 255, required : False, since : '4.20.1', related : 'listCniConfiguration'}], response : [{name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}]}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}]}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}]}]}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}]}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'diskwrite', description : 'Disk write in MiB', type : 'string'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}]}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'name', description : 'The name of the attached ISO', type : 'string'}]}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'networkwrite', description : 'Network write in MiB', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'networkread', description : 'Network read in MiB', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'diskiopstotal', description : 'The total disk iops', type : 'long'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'memorytotal', description : 'The total memory capacity in GiB', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'diskread', description : 'Disk read in MiB', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'cputotal', description : 'The total cpu capacity in Ghz', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}], httprequesttype : 'GET'}, {name : 'releaseIpAddress', description : 'Releases an IP address from the Account.', since : '4.17', isasync : False, params : [{name : 'id', description : 'The ID of the public IP address to release', type : 'uuid', length : 255, required : True, related : 'associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses'}], response : [{}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'reserveIpAddress', description : 'Reserve a public IP to an Account.', since : '4.17', isasync : False, related : 'associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses', params : [{name : 'projectid', description : 'The ID of the project to reserve with this IP address', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'domainid', description : 'The ID of the domain to reserve with this IP address', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'id', description : 'The ID of the public IP address to reserve', type : 'uuid', length : 255, required : True, related : 'associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses'}, {name : 'account', description : 'The Account to reserve with this IP address', type : 'string', length : 255, required : False}, {name : 'fordisplay', description : 'An optional field, whether to the display the IP to the end User or not', type : 'boolean', length : 255, required : False}], response : [{name : 'vpcid', description : 'VPC ID the IP belongs to', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the public IP address belongs', type : 'string'}, {name : 'state', description : 'State of the IP address. Can be: Allocating, Allocated, Releasing, Reserved and Free', type : 'string'}, {name : 'forsystemvms', description : 'true if range is dedicated for System VMs', type : 'boolean'}, {name : 'id', description : 'Public IP address ID', type : 'string'}, {name : 'project', description : 'The project name of the address', type : 'string'}, {name : 'domain', description : 'The domain the public IP address is associated with', type : 'string'}, {name : 'vpcname', description : 'VPC name the IP belongs to', type : 'string'}, {name : 'purpose', description : 'Purpose of the IP address. In Acton this value is not null for IPs with isSystem=true, and can have either StaticNat or LB value', type : 'string'}, {name : 'isstaticnat', description : 'True if this IP is for static NAT, false otherwise', type : 'boolean'}, {name : 'issourcenat', description : 'True if the IP address is a source NAT address, false otherwise', type : 'boolean'}, {name : 'virtualmachinename', description : 'Instance name the IP address is assigned to', type : 'string'}, {name : 'physicalnetworkid', description : 'The physical Network this belongs to', type : 'string'}, {name : 'issystem', description : 'True if this IP is system IP (was allocated as a part of deployVm or createLbRule)', type : 'boolean'}, {name : 'networkid', description : 'The ID of the Network where IP belongs to', type : 'string'}, {name : 'ipaddress', description : 'Public IP address', type : 'string'}, {name : 'isportable', description : 'Is public IP portable across the zones', type : 'boolean'}, {name : 'networkname', description : 'The name of the Network where IP belongs to', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'account', description : 'The Account the public IP address is associated with', type : 'string'}, {name : 'vlanid', description : 'The ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only', type : 'string'}, {name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {name : 'vmipaddress', description : 'Instance (DNAT) IP address (not null only for static NAT IP)', type : 'string'}, {name : 'vlanname', description : 'The VLAN associated with the IP address', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the Network associated with the IP address', type : 'string'}, {name : 'zoneid', description : 'The ID of the zone the public IP address belongs to', type : 'string'}, {name : 'associatednetworkid', description : 'The ID of the Network associated with the IP address', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the IP address', type : 'boolean'}, {name : 'tags', description : 'The list of resource tags associated with IP address', type : 'list', response : [{name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'virtualmachinetype', description : 'Instance type the IP address is assigned to', type : 'string'}, {name : 'hasrules', description : 'Whether the IP address has Firewall/PortForwarding/LoadBalancing rules defined', type : 'boolean'}, {name : 'fordisplay', description : 'Is public IP for display to the regular user', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainid', description : 'The domain ID the public IP address is associated with', type : 'string'}, {name : 'forprovider', description : 'true if range is dedicated for external network providers', type : 'boolean'}, {name : 'virtualmachinedisplayname', description : 'Instance display name the IP address is assigned to (not null only for static NAT IP)', type : 'string'}, {name : 'zonename', description : 'The name of the zone the public IP address belongs to', type : 'string'}, {name : 'virtualmachineid', description : 'Instance id the IP address is assigned to', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {}, {name : 'allocated', description : 'Date the public IP address was acquired', type : 'date'}], httprequesttype : 'POST'}, {name : 'deleteVMSchedule', description : 'Delete Instance Schedule.', since : '4.19.0', isasync : False, params : [{name : 'virtualmachineid', description : 'ID of Instance', type : 'uuid', length : 255, required : True, related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'id', description : 'ID of Instance schedule', type : 'uuid', length : 255, required : False, related : ''}, {name : 'ids', description : 'IDs of Instance schedule', type : 'list', length : 255, required : False, related : ''}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'deleteDnsRecord', description : 'Deletes a DNS record from the external provider', since : '4.23.0', isasync : True, params : [{name : 'dnszoneid', description : 'The ID of the DNS zone', type : 'uuid', length : 255, required : True, related : 'listDnsZones'}, {name : 'name', description : '', type : 'string', length : 255, required : True}, {name : 'type', description : '', type : 'string', length : 255, required : True}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'destroySharedFileSystem', description : 'Destroy a Shared FileSystem by id', since : '4.20.0', isasync : True, params : [{name : 'id', description : 'the ID of the shared filesystem to delete', type : 'uuid', length : 255, required : False, related : 'listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}, {name : 'expunge', description : 'If true is passed, the shared filesystem is expunged immediately. False by default.', type : 'boolean', length : 255, required : False}, {name : 'forced', description : 'If true is passed, the shared filesystem can be destroyed without stopping it first.', type : 'boolean', length : 255, required : False}], response : [{}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'listProjectRolePermissions', description : "Lists a project's project role permissions", since : '4.15.0', isasync : False, related : '', params : [{name : 'projectid', description : 'ID of the project', type : 'uuid', length : 255, required : True, related : 'createProject'}, {name : 'projectroleid', description : 'ID of the project role', type : 'uuid', length : 255, required : False, related : 'listProjectRoles,updateProjectRole'}], response : [{}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'permission', description : 'The permission type of the api name or wildcard rule, allow/deny', type : 'string'}, {name : 'description', description : 'The description of the role permission', type : 'string'}, {name : 'projectroleid', description : 'The ID of the project role to which the role permission belongs', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'rule', description : 'The api name or wildcard rule', type : 'string'}, {name : 'projectrolename', description : 'The name of the project role to which the role permission belongs', type : 'string'}, {name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'id', description : 'The ID of the project role permission', type : 'string'}], httprequesttype : 'GET'}, {name : 'createBucket', description : 'Creates a bucket in the specified object storage pool. ', since : '4.19.0', isasync : True, related : 'listBuckets', params : [{name : 'quota', description : 'Bucket Quota in GiB', type : 'integer', length : 255, required : True}, {name : 'policy', description : 'The Bucket access policy', type : 'string', length : 255, required : False}, {name : 'objectstorageid', description : 'Id of the Object Storage Pool where bucket is created', type : 'uuid', length : 255, required : True, related : 'addObjectStoragePool'}, {name : 'encryption', description : 'Enable bucket encryption', type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'the domain ID associated with the bucket. If used with the account parameter returns the bucket associated with the account for the specified domain.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'projectid', description : 'the project associated with the bucket. Mutually exclusive with account parameter', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'objectlocking', description : 'Enable object locking in bucket', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'the name of the bucket', type : 'string', length : 255, required : True}, {name : 'account', description : 'the account associated with the bucket. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'versioning', description : 'Enable bucket versioning', type : 'boolean', length : 255, required : False}], response : [{name : 'domainid', description : 'the ID of the domain associated with the bucket', type : 'string'}, {name : 'provider', description : 'Object storage provider', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'domain', description : 'the domain associated with the bucket', type : 'string'}, {name : 'name', description : 'name of the Bucket', type : 'string'}, {}, {name : 'size', description : 'Total size of objects in Bucket', type : 'long'}, {name : 'project', description : 'the project name of the bucket', type : 'string'}, {name : 'versioning', description : 'Bucket Versioning', type : 'boolean'}, {name : 'url', description : 'Bucket URL', type : 'string'}, {name : 'objectlocking', description : 'Bucket Object Locking', type : 'boolean'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'domainpath', description : 'path of the domain to which the bucket belongs', type : 'string'}, {name : 'projectid', description : 'the project id of the bucket', type : 'string'}, {name : 'usersecretkey', description : 'Bucket Secret Key', type : 'string'}, {}, {name : 'objectstorageid', description : 'id of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'created', description : 'the date the Bucket was created', type : 'date'}, {name : 'state', description : 'State of the Bucket', type : 'string'}, {name : 'quota', description : 'Bucket Quota in GiB', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'objectstore', description : 'Name of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'accesskey', description : 'Bucket Access Key', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'ID of the Bucket', type : 'string'}, {name : 'account', description : 'the account associated with the Bucket', type : 'string'}, {name : 'encryption', description : 'Bucket Encryption', type : 'boolean'}, {name : 'policy', description : 'Bucket Access Policy', type : 'string'}], httprequesttype : 'POST'}, {name : 'listRoutingFirewallRules', description : 'Lists all Routing firewall rules', since : '4.20.0', isasync : False, related : 'createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule', params : [{name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'id', description : 'Lists Routing firewall rule with the specified ID', type : 'uuid', length : 255, required : False, related : 'listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'traffictype', description : 'list Routing firewall rules by traffic type - ingress or egress', type : 'string', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'fordisplay', description : 'list resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'networkid', description : 'list Routing firewall rules by network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}], response : [{name : 'id', description : 'The ID of the port forwarding rule', type : 'string'}, {name : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID for the port forwarding rule', type : 'string'}, {name : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}, {name : 'state', description : 'The state of the rule', type : 'string'}, {name : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {name : 'virtualmachinedisplayname', description : 'The Instance display name for the port forwarding rule', type : 'string'}, {name : 'privateport', description : "The starting port of port forwarding rule's private port range", type : 'string'}, {}, {name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', type : 'string'}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'privateendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'list', response : [{name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'networkid', description : 'The ID of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {name : 'publicport', description : "The starting port of port forwarding rule's public port range", type : 'string'}, {}], httprequesttype : 'GET'}, {name : 'addVirtualMachinesToKubernetesCluster', description : 'Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.', since : '4.19.0', isasync : False, params : [{name : 'iscontrolnode', description : 'Is control node or not? Defaults to false.', type : 'boolean', length : 255, required : False}, {name : 'virtualmachineids', description : 'The IDs of the VMs to add to the cluster', type : 'list', length : 255, required : True, related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,updateKubernetesClusterAffinityGroups'}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'listBackupOfferings', description : 'Lists backup offerings', since : '4.14.0', isasync : False, related : 'updateBackupOffering,createBackupOffering', params : [{name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'zoneid', description : 'The zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The backup offering ID', type : 'uuid', length : 255, required : False, related : 'listBackupOfferings,updateBackupOffering,createBackupOffering'}], response : [{name : 'name', description : 'Name for the backup offering', type : 'string'}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'provider', description : 'provider name', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'crosszoneinstancecreation', description : 'the backups with this offering can be used to create Instances on all Zones', type : 'boolean'}, {name : 'backupofferingdetails', description : 'Details for the backup offering', type : 'map'}, {}, {name : 'allowuserdrivenbackups', description : 'Whether the offering allows User driven ad-hoc/scheduled backups', type : 'boolean'}, {name : 'externalid', description : 'External ID on the provider side', type : 'string'}, {name : 'zonename', description : 'Zone name', type : 'string'}, {}, {name : 'created', description : 'The date this backup offering was created', type : 'date'}, {name : 'domainid', description : 'the domain ID(s) this backup offering belongs to.', type : 'string'}, {name : 'id', description : 'ID of the backup offering', type : 'string'}, {name : 'domain', description : 'the domain name(s) this backup offering belongs to.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'description', description : 'Description for the backup offering', type : 'string'}], httprequesttype : 'GET'}, {name : 'listVnfTemplates', description : 'List all public, private, and privileged VNF templates.', since : '4.19.0', isasync : False, related : 'prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate', params : [{name : 'isready', description : 'list templates that are ready to be deployed', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'showremoved', description : 'Show removed Templates as well', type : 'boolean', length : 255, required : False}, {name : 'showicon', description : 'Flag to display the resource image for the Templates', type : 'boolean', length : 255, required : False}, {name : 'zoneid', description : 'List Templates by zoneId', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'details', description : 'Comma separated list of Template details requested, value can be a list of [all, min]', type : 'list', length : 255, required : False, since : '4.15'}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'name', description : 'The Template name', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'forcks', description : 'list templates that can be used to deploy CKS clusters', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'templatetype', description : 'the type of the template', type : 'string', length : 255, required : False, since : '4.19.0'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'parenttemplateid', description : 'List datadisk Templates by parent Template id', type : 'uuid', length : 255, required : False, since : '4.4', related : 'prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'arch', description : 'the CPU arch of the template. Valid options are: x86_64, aarch64, s390x', type : 'string', length : 255, required : False, since : '4.20'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'id', description : 'The Template ID', type : 'uuid', length : 255, required : False, related : 'prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'templatefilter', description : 'Possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : Templates that have been marked as featured and public. * self : Templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns Templates that can be used to deploy a new Instance. * sharedexecutable : Templates ready to be deployed that have been granted to the calling user by another user. * executable : Templates that are owned by the calling user, or public Templates, that can be used to deploy an Instance. * community : Templates that have been marked as public but not featured. * all : all Templates (only usable by admins).', type : 'string', length : 255, required : True}, {name : 'isvnf', description : 'flag to list VNF templates or not; true if need to list VNF templates, false otherwise.', type : 'boolean', length : 255, required : False, since : '4.19.0'}, {name : 'ids', description : 'The IDs of the Templates, mutually exclusive with id', type : 'list', length : 255, required : False, since : '4.9', related : 'prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'extensionid', description : 'ID of the extension for the template', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listExtensions,deleteExtension,updateExtension,unregisterExtension'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'hypervisor', description : 'The hypervisor for which to restrict the search', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'showunique', description : 'If set to true, list only unique Templates across zones', type : 'boolean', length : 255, required : False, since : '4.13.2'}, {name : 'oscategoryid', description : 'the ID of the OS category for the template', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listOsCategories'}], response : [{name : 'format', description : 'The format of the Template.', type : 'imageformat'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {}, {name : 'checksum', description : 'Checksum of the Template', type : 'string'}, {}, {name : 'userdataparams', description : 'List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata', type : 'string'}, {name : 'id', description : 'The Template ID', type : 'string'}, {name : 'userdataid', description : 'The id of userdata linked to this Template', type : 'string'}, {name : 'project', description : 'The project name of the Template', type : 'string'}, {name : 'deployasis', description : 'VMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.', type : 'boolean'}, {name : 'extensionid', description : 'The ID of extension linked to this template', type : 'string'}, {name : 'isready', description : 'True if the Template is ready to be deployed from, false otherwise.', type : 'boolean'}, {name : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'crossZones', description : 'True if the Template is managed across all Zones, false otherwise', type : 'boolean'}, {name : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {name : 'url', description : 'The URL which the Template/ISO is registered from', type : 'string'}, {name : 'extensionname', description : 'The name of extension linked to this template', type : 'string'}, {name : 'requireshvm', description : 'True if Template requires HVM enabled, false otherwise', type : 'boolean'}, {name : 'accountid', description : 'The Account id to which the Template belongs', type : 'string'}, {name : 'sourcetemplateid', description : 'The Template ID of the parent Template if present', type : 'string'}, {name : 'removed', description : 'The date this Template was removed', type : 'date'}, {name : 'hostname', description : 'The name of the secondary storage host for the Template', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean'}, {name : 'domainid', description : 'The ID of the domain to which the Template belongs', type : 'string'}, {name : 'sshkeyenabled', description : 'True if Template is sshkey enabled, false otherwise', type : 'boolean'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'templatetag', description : 'The tag of this Template', type : 'string'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'zonename', description : 'The name of the zone for this Template', type : 'string'}, {name : 'directdownload', description : 'KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage', type : 'boolean'}, {name : 'passwordenabled', description : 'True if the reset password feature is enabled, false otherwise', type : 'boolean'}, {name : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'parenttemplateid', description : 'If Datadisk Template, then id of the root disk Template this Template belongs to', type : 'string'}, {name : 'account', description : 'The Account name to which the Template belongs', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', type : 'string'}, {name : 'arch', description : 'CPU Arch of the template', type : 'string'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'bits', description : 'The processor bit size', type : 'int'}, {name : 'ostypeid', description : 'The ID of the OS type for this Template.', type : 'string'}, {name : 'hostid', description : 'The ID of the secondary storage host for the Template', type : 'string'}, {}, {name : 'userdataname', description : 'The name of userdata linked to this Template', type : 'string'}, {name : 'isextractable', description : 'True if the Template is extractable, false otherwise', type : 'boolean'}, {name : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean'}, {name : 'status', description : 'The status of the Template', type : 'string'}, {name : 'templatetype', description : 'The type of the Template', type : 'string'}, {name : 'size', description : 'The size of the Template', type : 'long'}, {name : 'domain', description : 'The name of the domain to which the Template belongs', type : 'string'}, {name : 'displaytext', description : 'The Template display text', type : 'string'}, {name : 'name', description : 'The Template name', type : 'string'}, {name : 'ispublic', description : 'True if this Template is a public Template, false otherwise', type : 'boolean'}], httprequesttype : 'GET'}, {name : 'deployVnfAppliance', description : 'Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.', since : '4.19.0', isasync : True, related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm', params : [{name : 'iodriverpolicy', description : 'Controls specific policies on IO', type : 'string', length : 255, required : False}, {name : 'serviceofferingid', description : 'The ID of the Service offering for the Instance', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'templateid', description : 'The ID of the Template for the Instance', type : 'uuid', length : 255, required : False, related : 'prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'datadiskofferinglist', description : "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", type : 'map', length : 255, required : False, since : '4.11'}, {name : 'macaddress', description : "the mac address for default vm's network", type : 'string', length : 255, required : False}, {name : 'ip6address', description : "the ipv6 address for default vm's network", type : 'string', length : 255, required : False}, {name : 'affinitygroupnames', description : 'comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter', type : 'list', length : 255, required : False, related : ''}, {name : 'vnfconfiguremanagement', description : 'False by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. True otherwise. Network rules are configured if management network is an isolated network or shared network with security groups.', type : 'boolean', length : 255, required : False}, {name : 'displayname', description : 'an optional user generated name for the virtual machine', type : 'string', length : 255, required : False}, {name : 'keyboard', description : 'an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,es-latam,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us', type : 'string', length : 255, required : False}, {name : 'boottype', description : 'Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.', type : 'string', length : 255, required : False, since : '4.14.0.0'}, {name : 'keypair', description : 'name of the ssh key pair used to login to the virtual machine', type : 'string', length : 255, required : False}, {name : 'leaseexpiryaction', description : 'Lease expiry action, valid values are STOP and DESTROY', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'iptonetworklist', description : "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", type : 'map', length : 255, required : False}, {name : 'userdata', description : 'an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value', type : 'string', length : 1048576, required : False}, {name : 'affinitygroupids', description : 'comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter', type : 'list', length : 255, required : False, related : ''}, {name : 'ipaddress', description : "the ip address for default vm's network", type : 'string', length : 255, required : False}, {name : 'extraconfig', description : 'an optional URL encoded string that can be passed to the virtual machine upon successful deployment', type : 'string', length : 5120, required : False, since : '4.12'}, {name : 'vnfcidrlist', description : 'the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0.', type : 'list', length : 255, required : False}, {name : 'rootdisksize', description : 'Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided', type : 'long', length : 255, required : False, since : '4.4'}, {name : 'rootdiskkmskeyid', description : 'ID of the KMS Key to use for root disk encryption', type : 'uuid', length : 255, required : False, since : '4.23.0', related : 'createKMSKey,updateKMSKey'}, {name : 'customid', description : 'An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only', type : 'string', length : 255, required : False}, {name : 'copyimagetags', description : 'if true the image tags (if any) will be copied to the VM, default value is false', type : 'boolean', length : 255, required : False, since : '4.13'}, {name : 'nicpackedvirtqueuesenabled', description : 'Enable packed virtqueues or not.', type : 'boolean', length : 255, required : False, since : '4.18'}, {name : 'deploymentplanner', description : 'Deployment planner to use for vm allocation. Available to ROOT admin only', type : 'string', length : 255, required : False, since : '4.4'}, {name : 'zoneid', description : 'availability zone for the virtual machine', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'diskofferingid', description : 'the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'domainid', description : 'an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'details', description : "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", type : 'map', length : 255, required : False, since : '4.3'}, {name : 'volumeid', description : '', type : 'uuid', length : 255, required : False, since : '4.21', related : 'createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}, {name : 'startvm', description : 'true if start vm after creating; defaulted to true if not specified', type : 'boolean', length : 255, required : False}, {name : 'dhcpoptionsnetworklist', description : 'DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com', type : 'map', length : 255, required : False}, {name : 'iothreadsenabled', description : 'IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.', type : 'boolean', length : 255, required : False}, {name : 'nicmultiqueuenumber', description : 'The number of queues for multiqueue NICs.', type : 'integer', length : 255, required : False, since : '4.18'}, {name : 'bootmode', description : 'Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.', type : 'string', length : 255, required : False, since : '4.14.0.0'}, {name : 'hostid', description : 'destination Host ID to deploy the VM to - parameter available for root admin only', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,reconnectHost'}, {name : 'password', description : 'The password of the virtual machine. If null, a random password will be generated for the VM.', type : 'string', length : 255, required : False, since : '4.19.0.0'}, {name : 'userdataid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.18', related : 'listCniConfiguration'}, {name : 'group', description : 'an optional group for the virtual machine', type : 'string', length : 255, required : False}, {name : 'externaldetails', description : 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'size', description : 'the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId', type : 'long', length : 255, required : False}, {name : 'networkids', description : "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", type : 'list', length : 255, required : False, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}, {name : 'securitygroupids', description : 'comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter', type : 'list', length : 255, required : False, related : 'updateSecurityGroup'}, {name : 'hypervisor', description : 'the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call', type : 'string', length : 255, required : False}, {name : 'name', description : 'host name for the virtual machine', type : 'string', length : 255, required : False}, {name : 'snapshotid', description : '', type : 'uuid', length : 255, required : False, since : '4.21', related : 'createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots'}, {name : 'properties', description : 'used to specify the vApp properties.', type : 'map', length : 255, required : False, since : '4.15'}, {name : 'securitygroupnames', description : 'comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter', type : 'list', length : 255, required : False, related : 'updateSecurityGroup'}, {name : 'displayvm', description : 'an optional field, whether to the display the vm to the end user or not.', type : 'boolean', length : 255, required : False, since : '4.2'}, {name : 'keypairs', description : 'names of the ssh key pairs used to login to the virtual machine', type : 'list', length : 255, required : False, since : '4.17'}, {name : 'leaseduration', description : 'Number of days instance is leased for.', type : 'integer', length : 255, required : False, since : '4.21.0'}, {name : 'dynamicscalingenabled', description : 'true if virtual machine needs to be dynamically scalable', type : 'boolean', length : 255, required : False, since : '4.16'}, {name : 'datadisksdetails', description : 'Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200&datadisksdetails[0].kmskeyid=<uuid>', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'userdatadetails', description : 'used to specify the parameters values for the variables in userdata.', type : 'map', length : 255, required : False, since : '4.18'}, {name : 'account', description : 'an optional account for the virtual machine. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'overridediskofferingid', description : 'the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id', type : 'uuid', length : 255, required : False, since : '4.17', related : ''}, {name : 'bootintosetup', description : 'Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)', type : 'boolean', length : 255, required : False, since : '4.15.0.0'}, {name : 'nicnetworklist', description : 'VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid', type : 'map', length : 255, required : False, since : '4.15'}, {name : 'projectid', description : 'Deploy vm for the project', type : 'uuid', length : 255, required : False, related : 'createProject'}], response : [{name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}]}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}]}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}]}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}]}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}]}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}]}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}]}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}], httprequesttype : 'POST'}, {name : 'stopKubernetesCluster', description : 'Stops a running CloudManaged Kubernetes cluster', isasync : True, params : [{name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,updateKubernetesClusterAffinityGroups'}], response : [{}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'startSharedFileSystem', description : 'Start a Shared FileSystem', since : '4.20.0', isasync : True, related : 'listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering', params : [{name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}], response : [{name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}]}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'associateDnsZoneToNetwork', description : 'Associates a DNS Zone with a Network for VM auto-registration', since : '4.23.0', isasync : False, related : '', params : [{name : 'networkid', description : 'The ID of the network', type : 'uuid', length : 255, required : True, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}, {name : 'subdomain', description : "Optional subdomain to append (e.g., 'dev' creates vm1.dev.example.com)", type : 'string', length : 255, required : False}, {name : 'dnszoneid', description : 'The ID of the DNS zone', type : 'uuid', length : 255, required : True, related : 'listDnsZones'}], response : [{}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'subdomain', description : 'The sub domain name of the auto-registered DNS record', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'dnszoneid', description : 'The ID of the DNS zone', type : 'string'}, {name : 'id', description : 'The ID of the mapping', type : 'string'}, {name : 'networkid', description : 'The ID of the Network', type : 'string'}], httprequesttype : 'POST'}, {name : 'scaleKubernetesCluster', description : 'Scales a created, running or stopped CloudManaged Kubernetes cluster', isasync : True, related : 'createKubernetesCluster,startKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean', length : 255, required : False}, {name : 'serviceofferingid', description : 'The ID of the service offering for the virtual machines in the cluster.', type : 'uuid', length : 255, required : False, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'minsize', description : 'Minimum number of worker nodes in the cluster', type : 'long', length : 255, required : False}, {name : 'nodeids', description : 'The IDs of the nodes to be removed', type : 'list', length : 255, required : False, related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'nodeofferings', description : '(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'maxsize', description : 'Maximum number of worker nodes in the cluster', type : 'long', length : 255, required : False}, {name : 'size', description : 'Number of Kubernetes cluster nodes', type : 'long', length : 255, required : False}], response : [{name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}], httprequesttype : 'POST'}, {name : 'destroyVolume', description : 'Destroys a Volume.', since : '4.14.0', isasync : True, related : 'createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume', params : [{name : 'expunge', description : 'If true is passed, the volume is expunged immediately. False by default.', type : 'boolean', length : 255, required : False, since : '4.6.0'}, {name : 'id', description : 'The ID of the volume', type : 'uuid', length : 255, required : True, related : 'createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}], response : [{name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}]}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'deviceid', description : 'The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.', type : 'long'}, {name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'vmstate', description : 'State of the Instance', type : 'string'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}], httprequesttype : 'POST'}, {name : 'stopSharedFileSystem', description : 'Stop a Shared FileSystem', since : '4.20.0', isasync : True, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering', params : [{name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}, {name : 'forced', description : 'Force stop the shared filesystem.', type : 'boolean', length : 255, required : False}], response : [{name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}]}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteRoutingFirewallRule', description : 'Deletes a routing firewall rule', since : '4.20.0', isasync : True, params : [{name : 'id', description : 'the ID of the Routing firewall rule', type : 'uuid', length : 255, required : True, related : 'createPortForwardingRule,updatePortForwardingRule'}], response : [{}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'changeServiceForSystemVm', description : 'Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect.', isasync : False, related : 'startSystemVm', params : [{name : 'details', description : 'Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value', type : 'map', length : 255, required : False}, {name : 'id', description : 'The ID of the System VM', type : 'uuid', length : 255, required : True, related : 'startSystemVm,changeServiceForSystemVm'}, {name : 'serviceofferingid', description : 'The service offering ID to apply to the System VM', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}], response : [{name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteVMSnapshot', description : 'Deletes an Instance Snapshot.', since : '4.2.0', isasync : True, params : [{name : 'vmsnapshotid', description : 'The ID of the Instance Snapshot', type : 'uuid', length : 255, required : True, related : 'listVMSnapshot,createVMSnapshot'}], response : [{}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listConsoleSessions', description : 'Lists console sessions.', since : '4.21.0', isasync : False, related : '', params : [{name : 'accountid', description : 'The ID of the account that created the console endpoint.', type : 'uuid', length : 255, required : False, related : 'disableAccount,enableAccount,updateAccount,listAccounts'}, {name : 'clientaddress', description : 'IP address of the client that accessed the console session.', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the console session.', type : 'uuid', length : 255, required : False, related : 'listConsoleSessions'}, {name : 'hostid', description : 'Lists console sessions from the specified host.', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,reconnectHost'}, {name : 'isrecursive', description : "Lists console sessions recursively per domain. If an account ID is informed, only the account's console sessions will be listed. Defaults to false.", type : 'boolean', length : 255, required : False}, {name : 'virtualmachineid', description : 'The ID of the virtual machine.', type : 'uuid', length : 255, required : False, related : 'assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'activeonly', description : 'Lists only active console sessions, defaults to true. Active sessions are the ones that have been acquired and have not been removed.', type : 'boolean', length : 255, required : False}, {name : 'startdate', description : 'Lists console sessions generated from this date onwards. The recommended format is "yyyy-MM-dd\'T\'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "00:00:00"). If the recommended format is not used, the date will be considered in the server timezone.', type : 'date', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'acquired', description : "Lists acquired console sessions, defaults to false. Acquired console sessions are the ones that have been accessed. The 'activeonly' parameter has precedence over the 'acquired' parameter, i.e., when the 'activeonly' parameter is 'true', the 'acquired' parameter value will be ignored.", type : 'boolean', length : 255, required : False}, {name : 'enddate', description : 'Lists console sessions generated up until this date. The recommended format is "yyyy-MM-dd\'T\'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "23:59:59"). If the recommended format is not used, the date will be considered in the server timezone.', type : 'date', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'consoleendpointcreatoraddress', description : 'IP address of the creator of the console endpoint.', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'The domain ID of the account that created the console endpoint.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'userid', description : 'The ID of the user that created the console endpoint.', type : 'uuid', length : 255, required : False, related : 'disableUser,getUser,listUsers,lockUser'}], response : [{}, {name : 'accountid', description : 'ID of the account that created the console endpoint.', type : 'string'}, {name : 'acquired', description : 'Date when the console session was acquired.', type : 'date'}, {name : 'clientaddress', description : 'IP address of the client that created the console session.', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'virtualmachinename', description : 'Name of the virtual machine.', type : 'string'}, {name : 'created', description : "Date when the console session's endpoint was created.", type : 'date'}, {name : 'domainpath', description : 'Domain path of the account that created the console endpoint.', type : 'string'}, {name : 'consoleendpointcreatoraddress', description : 'IP address of the creator of the console endpoint.', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the virtual machine.', type : 'string'}, {name : 'domain', description : 'Domain of the account that created the console endpoint.', type : 'string'}, {name : 'domainid', description : 'Domain ID of the account that created the console endpoint.', type : 'string'}, {name : 'user', description : 'User that created the console endpoint.', type : 'string'}, {name : 'hostname', description : 'Name of the host.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'ID of the console session.', type : 'string'}, {name : 'hostid', description : 'ID of the host.', type : 'string'}, {name : 'removed', description : 'Date when the console session was removed.', type : 'date'}, {}, {name : 'account', description : 'Account that created the console endpoint.', type : 'string'}, {name : 'userid', description : 'ID of the user that created the console endpoint.', type : 'string'}], httprequesttype : 'GET'}, {name : 'listCniConfiguration', description : 'List user data for CNI plugins', since : '4.21.0', isasync : False, related : '', params : [{name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'Userdata name to look for', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the Userdata', type : 'uuid', length : 255, required : False, related : 'listCniConfiguration'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}], response : [{}, {name : 'project', description : 'The project name of the User Data', type : 'string'}, {name : 'domainid', description : 'The domain id of the User Data owner', type : 'string'}, {name : 'userdata', description : 'Base64 encoded User Data content', type : 'string'}, {name : 'name', description : 'Name of the User Data', type : 'string'}, {name : 'id', description : 'ID of the User Data', type : 'string'}, {name : 'params', description : 'List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in the User Data', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'projectid', description : 'The project id of the User Data', type : 'string'}, {name : 'account', description : 'The owner of the User Data', type : 'string'}, {name : 'domain', description : 'The domain name of the User Data owner', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the User Data owner belongs', type : 'string'}, {}, {name : 'accountid', description : 'The owner id of the User Data', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}], httprequesttype : 'GET'}, {name : 'createSnapshotFromVMSnapshot', description : 'Creates an instant Snapshot of a volume from existing Instance Snapshot.', since : '4.10.0', isasync : True, related : 'copySnapshot,archiveSnapshot,listSnapshots', params : [{name : 'volumeid', description : 'The ID of the disk volume', type : 'uuid', length : 255, required : True, related : 'createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume'}, {name : 'vmsnapshotid', description : 'The ID of the Instance Snapshot', type : 'uuid', length : 255, required : True, related : 'listVMSnapshot,createVMSnapshot'}, {name : 'name', description : 'The name of the Snapshot', type : 'string', length : 255, required : False}], response : [{name : 'domain', description : "The domain name of the Snapshot's Account", type : 'string'}, {name : 'ostypeid', description : 'ID of the os on volume', type : 'string'}, {name : 'created', description : 'The date the Snapshot was created', type : 'date'}, {name : 'datastorestate', description : 'state of the snapshot on the datastore', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'snapshottype', description : 'The type of the Snapshot', type : 'string'}, {name : 'parentname', description : 'The parent name of the Snapshot', type : 'string'}, {name : 'project', description : 'The project name of the Snapshot', type : 'string'}, {name : 'revertable', description : 'Indicates whether the underlying storage supports reverting the volume to this Snapshot', type : 'boolean'}, {name : 'datastoretype', description : 'type of the datastore for the snapshot entry', type : 'string'}, {name : 'osdisplayname', description : 'Display name of the os on volume', type : 'string'}, {name : 'status', description : 'the status of the template', type : 'string'}, {name : 'datastorename', description : 'name of the datastore for the snapshot entry', type : 'string'}, {}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'projectid', description : 'The project id of the Snapshot', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'account', description : 'The Account associated with the Snapshot', type : 'string'}, {name : 'id', description : 'ID of the Snapshot', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'locationtype', description : 'Valid location types are primary and secondary.', type : 'string'}, {name : 'zonename', description : 'name of the availability zone', type : 'string'}, {name : 'volumetype', description : 'Type of the disk volume', type : 'string'}, {name : 'virtualsize', description : 'Virtual size of backedup Snapshot on image store', type : 'long'}, {name : 'datastoreid', description : 'ID of the datastore for the snapshot entry', type : 'string'}, {name : 'domainid', description : "The domain ID of the Snapshot's Account", type : 'string'}, {name : 'downloaddetails', description : 'download progress of a snapshot', type : 'map'}, {name : 'domainpath', description : "path of the Domain the snapshot's account belongs to", type : 'string'}, {name : 'volumeid', description : 'ID of the disk volume', type : 'string'}, {name : 'volumename', description : 'Name of the disk volume', type : 'string'}, {name : 'chainsize', description : 'chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true', type : 'long'}, {name : 'volumestate', description : 'state of the disk volume', type : 'string'}, {name : 'state', description : 'The state of the Snapshot. BackedUp means that Snapshot is ready to be used; Creating - the Snapshot is being allocated on the primary storage; BackingUp - the Snapshot is being backed up on secondary storage', type : 'state'}, {name : 'name', description : 'Name of the Snapshot', type : 'string'}, {name : 'parent', description : 'The parent ID of the Snapshot', type : 'string'}, {}, {name : 'physicalsize', description : 'Physical size of backed up Snapshot on image store', type : 'long'}, {name : 'intervaltype', description : 'Valid types are hourly, daily, weekly, monthy, Template, and none.', type : 'string'}], httprequesttype : 'POST'}, {name : 'listDnsServers', description : 'Lists DNS servers owned by the account.', since : '4.23.0', isasync : False, related : 'addDnsServer', params : [{name : 'providertype', description : 'filter by provider type (e.g. PowerDNS, Cloudflare)', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'id', description : 'the ID of the DNS server', type : 'uuid', length : 255, required : False, related : 'addDnsServer,listDnsServers'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}], response : [{name : 'provider', description : 'The provider type of the DNS server', type : 'string'}, {name : 'ispublic', description : 'Is the DNS server publicly available', type : 'boolean'}, {name : 'port', description : 'The port of the DNS server', type : 'integer'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'nameservers', description : 'Name servers entries associated to DNS server', type : 'list'}, {name : 'domain', description : 'the name of the domain associated with the DNS server', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'ID of the DNS server', type : 'string'}, {name : 'publicdomainsuffix', description : 'The public domain suffix for the DNS server', type : 'string'}, {name : 'state', description : 'The state of the account', type : 'string'}, {name : 'url', description : 'URL of the DNS server API', type : 'string'}, {name : 'account', description : 'the account associated with the DNS server', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the DNS server', type : 'string'}, {name : 'name', description : 'Name of the DNS server', type : 'string'}, {}, {}], httprequesttype : 'GET'}, {name : 'listBuckets', description : 'Lists all Buckets.', since : '4.19.0', isasync : False, related : '', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'objectstorageid', description : 'the ID of the object storage pool, available to ROOT admin only', type : 'uuid', length : 255, required : False, related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities'}, {name : 'name', description : 'the name of the bucket', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'id', description : 'the ID of the bucket', type : 'uuid', length : 255, required : False, related : 'listBuckets'}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'ids', description : 'the IDs of the Buckets, mutually exclusive with id', type : 'list', length : 255, required : False, related : 'listBuckets'}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'objectstorageid', description : 'id of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'account', description : 'the account associated with the Bucket', type : 'string'}, {name : 'objectstore', description : 'Name of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the bucket belongs', type : 'string'}, {name : 'provider', description : 'Object storage provider', type : 'string'}, {name : 'accesskey', description : 'Bucket Access Key', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the bucket', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'state', description : 'State of the Bucket', type : 'string'}, {name : 'objectlocking', description : 'Bucket Object Locking', type : 'boolean'}, {name : 'id', description : 'ID of the Bucket', type : 'string'}, {name : 'project', description : 'the project name of the bucket', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {}, {name : 'usersecretkey', description : 'Bucket Secret Key', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'policy', description : 'Bucket Access Policy', type : 'string'}, {name : 'name', description : 'name of the Bucket', type : 'string'}, {}, {name : 'domain', description : 'the domain associated with the bucket', type : 'string'}, {name : 'quota', description : 'Bucket Quota in GiB', type : 'integer'}, {name : 'encryption', description : 'Bucket Encryption', type : 'boolean'}, {name : 'projectid', description : 'the project id of the bucket', type : 'string'}, {name : 'url', description : 'Bucket URL', type : 'string'}, {name : 'created', description : 'the date the Bucket was created', type : 'date'}, {name : 'versioning', description : 'Bucket Versioning', type : 'boolean'}, {name : 'size', description : 'Total size of objects in Bucket', type : 'long'}], httprequesttype : 'GET'}, {name : 'stopInternalLoadBalancerVM', description : 'Stops an Internal LB Instance.', isasync : True, related : 'listRouters,changeServiceForRouter,listInternalLoadBalancerVMs', params : [{name : 'id', description : 'The ID of the internal LB Instance', type : 'uuid', length : 255, required : True, related : 'listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs'}, {name : 'forced', description : 'Force stop the Instance (Instance is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the Instance is stopped and should be marked as such.', type : 'boolean', length : 255, required : False}], response : [{name : 'ip6dns1', description : 'The first IPv6 DNS for the router', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the router', type : 'string'}, {}, {name : 'linklocalnetmask', description : 'The link local netmask for the router', type : 'string'}, {name : 'id', description : 'The ID of the router', type : 'string'}, {name : 'zonename', description : 'The Zone name for the router', type : 'string'}, {name : 'role', description : 'Role of the domain router', type : 'string'}, {name : 'domain', description : 'The domain associated with the router', type : 'string'}, {name : 'dns2', description : 'The second DNS for the router', type : 'string'}, {name : 'podname', description : 'The Pod name for the router', type : 'string'}, {name : 'ip6dns2', description : 'The second IPv6 DNS for the router', type : 'string'}, {name : 'templatename', description : 'The Template name for the router', type : 'string'}, {name : 'arch', description : 'CPU arch of the router', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the router', type : 'string'}, {name : 'templateid', description : 'The Template ID for the router', type : 'string'}, {name : 'healthcheckresults', description : 'Last executed health check result for the router', type : 'list', response : [{name : 'checkname', description : 'The name of the health check on the router', type : 'string'}, {name : 'lastupdated', description : 'The date this VPC was created', type : 'date'}, {name : 'details', description : 'Detailed response generated on running health check', type : 'string'}, {name : 'status', description : 'the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}', type : 'routerhealthstatus'}, {name : 'success', description : 'The result of the health check if available', type : 'boolean'}, {name : 'checktype', description : 'The type of the health check - basic or advanced', type : 'string'}]}, {name : 'hostcontrolstate', description : 'The control state of the host for the router', type : 'string'}, {name : 'domainid', description : 'The domain ID associated with the router', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the router', type : 'string'}, {name : 'hostname', description : 'The hostname for the router', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'publicip', description : 'The public IP address for the router', type : 'string'}, {name : 'guestnetmask', description : 'The guest netmask for the router', type : 'string'}, {name : 'scriptsversion', description : 'The version of scripts', type : 'string'}, {name : 'gateway', description : 'The gateway for the router', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'linklocalnetworkid', description : 'The ID of the corresponding link local Network', type : 'string'}, {name : 'isredundantrouter', description : 'If this router is an redundant virtual router', type : 'boolean'}, {name : 'state', description : 'The state of the router', type : 'state'}, {name : 'publicnetmask', description : 'The public netmask for the router', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the router', type : 'string'}, {name : 'guestipaddress', description : 'The guest IP address for the router', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'healthchecksfailed', description : 'True if any health checks had failed', type : 'boolean'}, {name : 'requiresupgrade', description : 'True if the router Template requires upgrade', type : 'boolean'}, {name : 'hostid', description : 'The host ID for the router', type : 'string'}, {name : 'name', description : 'The name of the router', type : 'string'}, {name : 'guestnetworkid', description : 'The ID of the corresponding guest Network', type : 'string'}, {name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {name : 'redundantstate', description : 'The state of redundant virtual router', type : 'string'}, {name : 'version', description : 'The version of Template', type : 'string'}, {name : 'vpcname', description : 'The name of VPC the router belongs to', type : 'string'}, {name : 'dns1', description : 'The first DNS for the router', type : 'string'}, {name : 'created', description : 'The date and time the router was created', type : 'date'}, {name : 'softwareversion', description : 'The version of the code / software in the router', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with the router', type : 'set', response : [{name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}]}, {name : 'podid', description : 'The Pod ID for the router', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'publicmacaddress', description : 'The public MAC address for the router', type : 'string'}, {}, {name : 'domainpath', description : 'path of the Domain the router belongs to', type : 'string'}, {name : 'vpcid', description : 'VPC the router belongs to', type : 'string'}, {name : 'publicnetworkid', description : 'The ID of the corresponding public Network', type : 'string'}, {name : 'guestmacaddress', description : 'The guest MAC address for the router', type : 'string'}, {name : 'guestnetworkname', description : 'The name of the corresponding guest Network', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'project', description : 'The project name of the address', type : 'string'}, {name : 'account', description : 'The Account associated with the router', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteUserData', description : 'Deletes a userdata', since : '4.18', isasync : False, params : [{name : 'projectid', description : 'An optional project for the userdata', type : 'uuid', length : 255, required : False, related : ''}, {name : 'id', description : 'The ID of the Userdata', type : 'uuid', length : 255, required : True, related : ''}, {name : 'domainid', description : 'An optional domainId for the userdata. If the account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'listDomains,listDomains'}, {name : 'account', description : 'An optional account for the userdata. Must be used with domainId.', type : 'string', length : 255, required : False}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}], httprequesttype : 'POST'}, {name : 'listVmsForImport', description : 'Lists virtual machines on a unmanaged host', since : '4.19.0', isasync : False, related : 'listVmwareDcVms,listUnmanagedInstances', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'password', description : 'the password for the host', type : 'string', length : 255, required : False}, {name : 'host', description : 'the host name or IP address', type : 'string', length : 255, required : True}, {name : 'username', description : 'the username for the host', type : 'string', length : 255, required : False}, {name : 'hypervisor', description : 'hypervisor type of the host', type : 'string', length : 255, required : True}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'memory', description : 'The memory of the Instance in MB', type : 'integer'}, {name : 'hypervisorversion', description : 'The hypervisor version of the host to which Instance belongs', type : 'string'}, {name : 'cpunumber', description : 'The CPU cores of the Instance', type : 'integer'}, {name : 'osid', description : 'The operating system ID of the Instance', type : 'string'}, {name : 'cpucorepersocket', description : 'The CPU cores per socket for the Instance. VMware specific', type : 'integer'}, {name : 'boottype', description : 'indicates the boot type', type : 'string'}, {name : 'hostname', description : 'The name of the host to which Instance belongs', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor to which Instance belongs', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'powerstate', description : 'The power state of the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'clusterid', description : 'The ID of the cluster to which Instance belongs', type : 'string'}, {name : 'disk', description : 'The list of disks associated with the Instance', type : 'set', response : [{name : 'id', description : 'The ID of the disk', type : 'string'}, {name : 'datastorehost', description : 'The controller of the disk', type : 'string'}, {name : 'capacity', description : 'The capacity of the disk in bytes', type : 'long'}, {name : 'imagepath', description : 'The file path of the disk image', type : 'string'}, {name : 'position', description : 'The position of the disk', type : 'integer'}, {name : 'label', description : 'The label of the disk', type : 'string'}, {name : 'datastorepath', description : 'The controller of the disk', type : 'string'}, {name : 'controllerunit', description : 'The controller unit of the disk', type : 'integer'}, {name : 'datastorename', description : 'The controller of the disk', type : 'string'}, {name : 'datastoretype', description : 'The controller of the disk', type : 'string'}, {name : 'controller', description : 'The controller of the disk', type : 'string'}]}, {}, {name : 'cpuspeed', description : 'The CPU speed of the Instance', type : 'integer'}, {name : 'bootmode', description : 'indicates the boot mode', type : 'string'}, {}, {name : 'nic', description : 'The list of NICs associated with the Instance', type : 'set', response : [{name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}]}, {name : 'hostid', description : 'The ID of the host to which Instance belongs', type : 'string'}, {name : 'clustername', description : 'the name of the cluster to which virtual machine belongs', type : 'string'}, {name : 'osdisplayname', description : 'The operating system of the Instance', type : 'string'}], httprequesttype : 'GET'}, {name : 'deleteUserFromProject', description : 'Deletes User from the project', since : '4.15.0', isasync : True, params : [{name : 'userid', description : 'Id of the User to be removed from the project', type : 'uuid', length : 255, required : True, related : 'disableUser,getUser,listUsers,lockUser'}, {name : 'projectid', description : 'ID of the project to remove the User from', type : 'uuid', length : 255, required : True, related : ''}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], httprequesttype : 'POST'}, {name : 'listProjectRoles', description : 'Lists Project roles in CloudStack', since : '4.15.0', isasync : False, related : 'updateProjectRole', params : [{name : 'name', description : 'List project role by project role name.', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'projectroleid', description : 'List project role by project role ID.', type : 'uuid', length : 255, required : False, related : 'listProjectRoles,updateProjectRole'}, {name : 'projectid', description : 'List project role by project ID.', type : 'uuid', length : 255, required : True, related : ''}], response : [{name : 'id', description : 'The ID of the role', type : 'string'}, {name : 'name', description : 'The name of the role', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'description', description : 'The description of the role', type : 'string'}, {name : 'ispublic', description : 'Indicates whether the role will be visible to all Users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).', type : 'boolean'}, {}, {name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'restoreBackup', description : 'Restores an existing stopped or deleted Instance using an Instance backup', since : '4.14.0', isasync : True, params : [{name : 'hostid', description : 'If quickrestore is true, which host to start the VM on; otherwise, ignored. Currently this parameter is only supported by the KBOSS provider.', type : 'uuid', length : 255, required : False, since : '4.23.0', related : 'declareHostAsDegraded,reconnectHost'}, {name : 'quickrestore', description : 'Whether to use the quick restore process or not. Currently this parameter is only supported by the KBOSS provider.', type : 'boolean', length : 255, required : False, since : '4.23.0', related : ''}, {name : 'id', description : 'ID of the backup', type : 'uuid', length : 255, required : True, related : ''}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listDnsZones', description : 'Lists DNS zones.', since : '4.23.0', isasync : False, related : '', params : [{name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'name', description : 'List by zone name', type : 'string', length : 255, required : False}, {name : 'dnsserverid', description : 'List DNS zones belonging to a specific DNS server', type : 'uuid', length : 255, required : False, related : 'addDnsServer'}, {name : 'id', description : 'List DNS zone by ID', type : 'uuid', length : 255, required : False, related : 'listDnsZones'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'networkname', description : 'Name of the network this zone is associated with', type : 'string'}, {name : 'account', description : 'the account associated with the DNS zone', type : 'string'}, {name : 'domain', description : 'the name of the domain associated with the DNS zone', type : 'string'}, {name : 'state', description : 'The state of the zone (Active/Inactive)', type : 'state'}, {name : 'id', description : 'ID of the DNS zone', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'dnsserverid', description : 'ID of the DNS server this zone belongs to', type : 'string'}, {name : 'type', description : 'The type of the zone (Public/Private)', type : 'zonetype'}, {name : 'description', description : 'Description for the DNS zone', type : 'string'}, {}, {}, {name : 'name', description : 'Name of the DNS zone', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the DNS server', type : 'string'}, {name : 'dnsservername', description : 'the name of the DNS server hosting this zone', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'networkid', description : 'ID of the network this zone is associated with', type : 'string'}, {name : 'dnsserveraccount', description : 'the account name of the DNS server owner', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateVmNic', description : 'Updates the specified VM NIC', isasync : True, related : '', params : [{name : 'enabled', description : 'If true, sets the NIC state to UP; otherwise, sets the NIC state to DOWN', type : 'boolean', length : 255, required : False}, {name : 'nicid', description : 'NIC ID', type : 'uuid', length : 255, required : True, related : 'updateVmNic'}], response : [{name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}], httprequesttype : 'POST'}, {name : 'registerCniConfiguration', description : 'Register a CNI Configuration to be used with CKS cluster', since : '4.21.0', isasync : False, params : [{name : 'name', description : 'Name of the user data', type : 'string', length : 255, required : True}, {name : 'domainid', description : 'an optional domainId for the user data. If the account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'cniconfig', description : 'CNI Configuration content to be registered as User data', type : 'string', length : 1048576, required : False}, {name : 'account', description : 'an optional account for the user data. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'params', description : 'comma separated list of variables declared in user data content', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'an optional project for the user data', type : 'uuid', length : 255, required : False, related : ''}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'linkUserDataToTemplate', description : 'Link or unlink a userdata to a Template.', since : '4.18.0', isasync : False, related : 'listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate', params : [{name : 'isoid', description : 'The ID of the ISO for the Instance', type : 'uuid', length : 255, required : False, related : 'listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'userdataid', description : 'The ID of the userdata that has to be linked to Template/ISO. If not provided existing userdata will be unlinked from the Template/ISO', type : 'uuid', length : 255, required : False, related : ''}, {name : 'templateid', description : 'The ID of the Template for the Instance', type : 'uuid', length : 255, required : False, related : 'listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'userdatapolicy', description : 'An optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride', type : 'string', length : 255, required : False}], response : [{name : 'userdataid', description : 'The id of userdata linked to this Template', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'hostname', description : 'The name of the secondary storage host for the Template', type : 'string'}, {name : 'directdownload', description : 'KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage', type : 'boolean'}, {name : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {name : 'id', description : 'The Template ID', type : 'string'}, {name : 'parenttemplateid', description : 'If Datadisk Template, then id of the root disk Template this Template belongs to', type : 'string'}, {name : 'userdataparams', description : 'List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata', type : 'string'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'bits', description : 'The processor bit size', type : 'int'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'project', description : 'The project name of the Template', type : 'string'}, {name : 'url', description : 'The URL which the Template/ISO is registered from', type : 'string'}, {name : 'arch', description : 'CPU Arch of the template', type : 'string'}, {name : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'userdataname', description : 'The name of userdata linked to this Template', type : 'string'}, {}, {name : 'templatetype', description : 'The type of the Template', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {name : 'status', description : 'The status of the Template', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'deployasis', description : 'VMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.', type : 'boolean'}, {name : 'extensionname', description : 'The name of extension linked to this template', type : 'string'}, {name : 'name', description : 'The Template name', type : 'string'}, {name : 'domain', description : 'The name of the domain to which the Template belongs', type : 'string'}, {name : 'zonename', description : 'The name of the zone for this Template', type : 'string'}, {name : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {name : 'domainid', description : 'The ID of the domain to which the Template belongs', type : 'string'}, {name : 'ostypeid', description : 'The ID of the OS type for this Template.', type : 'string'}, {name : 'checksum', description : 'Checksum of the Template', type : 'string'}, {name : 'extensionid', description : 'The ID of extension linked to this template', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'accountid', description : 'The Account id to which the Template belongs', type : 'string'}, {name : 'templatetag', description : 'The tag of this Template', type : 'string'}, {}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'sshkeyenabled', description : 'True if Template is sshkey enabled, false otherwise', type : 'boolean'}, {name : 'requireshvm', description : 'True if Template requires HVM enabled, false otherwise', type : 'boolean'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'passwordenabled', description : 'True if the reset password feature is enabled, false otherwise', type : 'boolean'}, {name : 'removed', description : 'The date this Template was removed', type : 'date'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {name : 'isextractable', description : 'True if the Template is extractable, false otherwise', type : 'boolean'}, {name : 'isready', description : 'True if the Template is ready to be deployed from, false otherwise.', type : 'boolean'}, {}, {name : 'format', description : 'The format of the Template.', type : 'imageformat'}, {name : 'ispublic', description : 'True if this Template is a public Template, false otherwise', type : 'boolean'}, {name : 'displaytext', description : 'The Template display text', type : 'string'}, {name : 'hostid', description : 'The ID of the secondary storage host for the Template', type : 'string'}, {name : 'crossZones', description : 'True if the Template is managed across all Zones, false otherwise', type : 'boolean'}, {name : 'account', description : 'The Account name to which the Template belongs', type : 'string'}, {name : 'size', description : 'The size of the Template', type : 'long'}, {name : 'sourcetemplateid', description : 'The Template ID of the parent Template if present', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}], httprequesttype : 'POST'}, {name : 'listCustomActions', description : 'Lists the custom actions', since : '4.21.0', isasync : False, related : '', params : [{name : 'extensionid', description : 'uuid of the extension', type : 'uuid', length : 255, required : False, related : 'listExtensions,updateExtension'}, {name : 'enabled', description : 'List actions whether they are enabled or not', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'Name of the custom action', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'resourcetype', description : 'Type of the resource for actions', type : 'string', length : 255, required : False}, {name : 'id', description : 'uuid of the custom action', type : 'uuid', length : 255, required : False, related : 'listCustomActions'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'resourceid', description : 'ID of a resource for actions', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'timeout', description : 'Specifies the timeout in seconds to wait for the action to complete before failing', type : 'integer'}, {name : 'enabled', description : 'Whether the custom action is enabled or not', type : 'boolean'}, {}, {name : 'description', description : 'Description of the custom action', type : 'string'}, {name : 'resourcetype', description : 'Resource type for which the action is available', type : 'string'}, {name : 'details', description : 'Details of the custom action', type : 'map'}, {name : 'successmessage', description : 'Message that will be used on successful execution of the action', type : 'string'}, {name : 'parameters', description : 'List of the parameters for the action', type : 'list', response : [{name : 'required', description : 'Whether the parameter is required or not', type : 'boolean'}, {name : 'valueoptions', description : 'Comma-separated list of options for value of the parameter', type : 'list'}, {name : 'validationformat', description : 'Validation format for value of the parameter. Available for specific types', type : 'string'}, {name : 'type', description : 'Type of the parameter', type : 'string'}, {name : 'name', description : 'Name of the parameter', type : 'string'}]}, {name : 'allowedroletypes', description : 'List of role types allowed for the custom action', type : 'list'}, {}, {name : 'created', description : 'Creation timestamp of the custom action', type : 'date'}, {name : 'name', description : 'Name of the custom action', type : 'string'}, {name : 'extensionname', description : 'Name of the extension that this custom action belongs to', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'ID of the custom action', type : 'string'}, {name : 'extensionid', description : 'ID of the extension that this custom action belongs to', type : 'string'}, {name : 'errormessage', description : 'Message that will be used on failure during execution of the action', type : 'string'}], httprequesttype : 'GET'}, {name : 'getKubernetesClusterConfig', description : 'Get Kubernetes cluster config', isasync : False, related : '', params : [{name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : False, related : 'createKubernetesCluster,startKubernetesCluster,updateKubernetesClusterAffinityGroups'}], response : [{name : 'id', description : 'The ID of the container cluster', type : 'string'}, {}, {name : 'configdata', description : 'The config data of the cluster', type : 'string'}, {name : 'name', description : 'Name of the container cluster', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], httprequesttype : 'GET'}, {name : 'disassociateDnsZoneFromNetwork', description : 'Removes the association between a DNS Zone and a Network', since : '4.23.0', isasync : False, params : [{name : 'networkid', description : 'The ID of the Network', type : 'uuid', length : 255, required : True, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork'}], response : [{}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listInternalLoadBalancerVMs', description : 'List internal LB Instances.', isasync : False, related : 'listRouters', params : [{name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'vpcid', description : 'List Internal LB Instances by VPC', type : 'uuid', length : 255, required : False, related : 'listVPCs,createVPC,listVPCs,updateVPC'}, {name : 'id', description : 'The ID of the Internal LB Instance', type : 'uuid', length : 255, required : False, related : 'deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'podid', description : 'The Pod ID of the Internal LB Instance', type : 'uuid', length : 255, required : False, related : 'createManagementNetworkIpRange'}, {name : 'forvpc', description : 'If true is passed for this parameter, list only VPC Internal LB Instances', type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'hostid', description : 'The host ID of the Internal LB Instance', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,reconnectHost'}, {name : 'zoneid', description : 'The Zone ID of the Internal LB Instance', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'state', description : 'The state of the Internal LB Instance', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'name', description : 'The name of the Internal LB Instance', type : 'string', length : 255, required : False}, {name : 'fetchhealthcheckresults', description : 'If true is passed for this parameter, also fetch last executed health check results for the Instance. Default is false', type : 'boolean', length : 255, required : False, since : '4.14'}], response : [{name : 'hostname', description : 'The hostname for the router', type : 'string'}, {name : 'created', description : 'The date and time the router was created', type : 'date'}, {name : 'zoneid', description : 'The Zone ID for the router', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'podname', description : 'The Pod name for the router', type : 'string'}, {name : 'vpcname', description : 'The name of VPC the router belongs to', type : 'string'}, {name : 'role', description : 'Role of the domain router', type : 'string'}, {name : 'vpcid', description : 'VPC the router belongs to', type : 'string'}, {name : 'version', description : 'The version of Template', type : 'string'}, {name : 'templatename', description : 'The Template name for the router', type : 'string'}, {name : 'publicnetworkid', description : 'The ID of the corresponding public Network', type : 'string'}, {name : 'guestipaddress', description : 'The guest IP address for the router', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with the router', type : 'set', response : [{name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}]}, {name : 'scriptsversion', description : 'The version of scripts', type : 'string'}, {name : 'arch', description : 'CPU arch of the router', type : 'string'}, {name : 'ip6dns1', description : 'The first IPv6 DNS for the router', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the router belongs to', type : 'string'}, {}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {name : 'domain', description : 'The domain associated with the router', type : 'string'}, {name : 'publicip', description : 'The public IP address for the router', type : 'string'}, {name : 'healthcheckresults', description : 'Last executed health check result for the router', type : 'list', response : [{name : 'lastupdated', description : 'The date this VPC was created', type : 'date'}, {name : 'details', description : 'Detailed response generated on running health check', type : 'string'}, {name : 'success', description : 'The result of the health check if available', type : 'boolean'}, {name : 'status', description : 'the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}', type : 'routerhealthstatus'}, {name : 'checktype', description : 'The type of the health check - basic or advanced', type : 'string'}, {name : 'checkname', description : 'The name of the health check on the router', type : 'string'}]}, {name : 'publicnetmask', description : 'The public netmask for the router', type : 'string'}, {name : 'redundantstate', description : 'The state of redundant virtual router', type : 'string'}, {name : 'hostid', description : 'The host ID for the router', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the router', type : 'string'}, {name : 'ip6dns2', description : 'The second IPv6 DNS for the router', type : 'string'}, {name : 'dns1', description : 'The first DNS for the router', type : 'string'}, {name : 'gateway', description : 'The gateway for the router', type : 'string'}, {name : 'guestmacaddress', description : 'The guest MAC address for the router', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'linklocalnetmask', description : 'The link local netmask for the router', type : 'string'}, {name : 'zonename', description : 'The Zone name for the router', type : 'string'}, {name : 'healthchecksfailed', description : 'True if any health checks had failed', type : 'boolean'}, {name : 'guestnetworkid', description : 'The ID of the corresponding guest Network', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the router', type : 'string'}, {name : 'isredundantrouter', description : 'If this router is an redundant virtual router', type : 'boolean'}, {name : 'linklocalnetworkid', description : 'The ID of the corresponding link local Network', type : 'string'}, {name : 'templateid', description : 'The Template ID for the router', type : 'string'}, {}, {name : 'networkdomain', description : 'The Network domain for the router', type : 'string'}, {name : 'guestnetmask', description : 'The guest netmask for the router', type : 'string'}, {name : 'softwareversion', description : 'The version of the code / software in the router', type : 'string'}, {name : 'id', description : 'The ID of the router', type : 'string'}, {name : 'dns2', description : 'The second DNS for the router', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the router', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'guestnetworkname', description : 'The name of the corresponding guest Network', type : 'string'}, {name : 'requiresupgrade', description : 'True if the router Template requires upgrade', type : 'boolean'}, {name : 'state', description : 'The state of the router', type : 'state'}, {name : 'podid', description : 'The Pod ID for the router', type : 'string'}, {name : 'domainid', description : 'The domain ID associated with the router', type : 'string'}, {name : 'project', description : 'The project name of the address', type : 'string'}, {name : 'name', description : 'The name of the router', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the router', type : 'string'}, {name : 'account', description : 'The Account associated with the router', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}], httprequesttype : 'GET'}, {name : 'uploadResourceIcon', description : 'Uploads an icon for the specified resource(s)', since : '4.16.0.0', isasync : False, params : [{name : 'base64image', description : 'Base64 string representation of the resource icon/image', type : 'string', length : 2097152, required : True}, {name : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : True}, {name : 'resourceids', description : 'List of resources to upload the icon/image for', type : 'list', length : 255, required : True}], response : [{}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listHSMProfiles', description : 'Lists HSM profiles', since : '4.23.0', isasync : False, related : '', params : [{name : 'enabled', description : 'list only enabled profiles', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'the HSM profile ID', type : 'uuid', length : 255, required : False, related : 'listHSMProfiles'}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'ispublic', description : 'when true, non-admin users see only system (global) profiles', type : 'boolean', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'protocol', description : 'the protocol of the HSM profile', type : 'string', length : 255, required : False}], response : [{name : 'domainid', description : 'the domain ID of the HSM profile owner', type : 'string'}, {name : 'id', description : 'the ID of the HSM profile', type : 'string'}, {name : 'accountid', description : 'the account ID of the HSM profile owner', type : 'string'}, {name : 'projectid', description : 'the project ID of the HSM profile owner', type : 'string'}, {}, {name : 'zonename', description : 'the zone name where the HSM profile is available', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'state', description : 'the state of the HSM profile', type : 'string'}, {name : 'project', description : 'the project name of the HSM profile owner', type : 'string'}, {name : 'domain', description : 'the domain name of the HSM profile owner', type : 'string'}, {}, {name : 'enabled', description : 'whether the HSM profile is enabled', type : 'boolean'}, {name : 'created', description : 'the date the HSM profile was created', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'protocol', description : 'the protocol of the HSM profile', type : 'string'}, {name : 'details', description : 'HSM configuration details (sensitive values are encrypted)', type : 'map'}, {name : 'ispublic', description : 'whether this is a system HSM profile available to all users globally', type : 'boolean'}, {name : 'account', description : 'the account name of the HSM profile owner', type : 'string'}, {name : 'domainpath', description : 'the domain path of the HSM profile owner', type : 'string'}, {name : 'name', description : 'the name of the HSM profile', type : 'string'}, {name : 'zoneid', description : 'the zone ID where the HSM profile is available', type : 'string'}, {name : 'vendor', description : 'the vendor name of the HSM profile', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateAutoScaleVmProfile', description : 'Updates an existing autoscale Instance profile.', isasync : True, related : 'listAutoScaleVmProfiles', params : [{name : 'serviceofferingid', description : 'The service offering of the auto deployed  Instance', type : 'uuid', length : 255, required : False, since : '4.18.0', related : 'updateServiceOffering,listServiceOfferings'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer', length : 255, required : False}, {name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId of the auto deployed  Instance. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids\'" and "networkids".', type : 'map', length : 255, required : False, since : '4.18.0'}, {name : 'autoscaleuserid', description : 'The ID of the user used to launch and destroy the Instances', type : 'uuid', length : 255, required : False, related : 'disableUser,getUser,listUsers,lockUser'}, {name : 'userdatadetails', description : 'used to specify the parameters values for the variables in userdata.', type : 'map', length : 255, required : False, since : '4.18.1'}, {name : 'fordisplay', description : 'An optional field, whether to the display the profile to the end user or not', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'userdataid', description : 'the ID of the userdata', type : 'uuid', length : 255, required : False, since : '4.18.1', related : ''}, {name : 'counterparam', description : 'counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161', type : 'map', length : 255, required : False}, {name : 'templateid', description : 'The Template of the auto deployed Instance', type : 'uuid', length : 255, required : False, related : 'listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'id', description : 'The ID of the autoscale Instance profile', type : 'uuid', length : 255, required : True, related : 'listAutoScaleVmProfiles,updateAutoScaleVmProfile'}, {name : 'customid', description : 'An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only', type : 'string', length : 255, required : False, since : '4.4'}, {name : 'userdata', description : 'An optional binary data that can be sent to the  Instance upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value', type : 'string', length : 1048576, required : False, since : '4.18.0'}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'projectid', description : 'The project id Instance profile', type : 'string'}, {name : 'userdatadetails', description : 'list of variables and values for the variables declared in userdata', type : 'string'}, {name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance', type : 'map'}, {name : 'templateid', description : 'The Template to be used while deploying an Instance', type : 'string'}, {}, {name : 'domainid', description : 'The domain ID of the Instance profile', type : 'string'}, {name : 'userdata', description : 'Base64 encoded Instance user data', type : 'string'}, {name : 'autoscaleuserid', description : 'The ID of the User used to launch and destroy the Instances', type : 'string'}, {}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'serviceofferingid', description : 'The service offering to be used while deploying an Instance', type : 'string'}, {name : 'userdatapolicy', description : 'the userdata override policy with the userdata provided while deploying VM', type : 'string'}, {name : 'id', description : 'The autoscale Instance profile ID', type : 'string'}, {name : 'userdataid', description : 'the id of userdata used for the VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainpath', description : 'path of the domain to which the vm profile belongs', type : 'string'}, {name : 'userdataname', description : 'the name of userdata used for the VM', type : 'string'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer'}, {}, {name : 'domain', description : 'The domain name of the Instance profile', type : 'string'}, {name : 'project', description : 'The project name of the Instance profile', type : 'string'}, {name : 'fordisplay', description : 'Is profile for display to the regular User', type : 'boolean'}, {}, {name : 'zoneid', description : 'The availability zone to be used while deploying an Instance', type : 'string'}], httprequesttype : 'POST'}, {name : 'enableAutoScaleVmGroup', description : 'Enables an AutoScale Instance Group', isasync : True, related : '', params : [{name : 'id', description : 'The ID of the autoscale group', type : 'uuid', length : 255, required : True, related : 'enableAutoScaleVmGroup'}], response : [{name : 'lbprovider', description : 'The LB provider of the guest Network the LB rule belongs to', type : 'string'}, {name : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {}, {name : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {name : 'publicport', description : 'The public port', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}, {name : 'publicip', description : 'The public IP address', type : 'string'}, {name : 'projectid', description : 'The project id of the Instance group', type : 'string'}, {name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {name : 'associatednetworkname', description : 'The name of the guest Network the LB rule belongs to', type : 'string'}, {name : 'maxmembers', description : 'The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.', type : 'int'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {name : 'privateport', description : 'The private port', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {}, {name : 'created', description : 'The date when this Instance group was created', type : 'date'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'minmembers', description : 'The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.', type : 'int'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'project', description : 'The project name of the Instance group', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'state', description : 'The current state of the AutoScale Instance Group', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'publicipid', description : 'The public IP address ID', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the vm group belongs', type : 'string'}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'deleteWebhookDelivery', description : 'Deletes Webhook delivery', since : '4.20.0', isasync : False, params : [{name : 'startdate', description : 'The start date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having start date equal to or after the specified date will be considered.', type : 'date', length : 255, required : False}, {name : 'managementserverid', description : 'The ID of the management server', type : 'uuid', length : 255, required : False, related : ''}, {name : 'enddate', description : 'The end date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having end date equal to or before the specified date will be considered.', type : 'date', length : 255, required : False}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,updateWebhook'}, {name : 'id', description : 'The ID of the Webhook delivery', type : 'uuid', length : 255, required : False, related : ''}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'listVmwareDcVms', description : 'Lists the VMs in a VMware Datacenter', isasync : False, related : 'listUnmanagedInstances', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'datacentername', description : 'Name of VMware datacenter.', type : 'string', length : 255, required : False}, {name : 'hostname', description : 'Name of the host on vCenter. Must be set along with the instancename parameter', type : 'string', length : 255, required : False}, {name : 'username', description : 'The Username required to connect to resource.', type : 'string', length : 255, required : False}, {name : 'vcenter', description : 'The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'instancename', description : 'Name of the VM on vCenter. Must be set along with the hostname parameter', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'password', description : 'The password for specified username.', type : 'string', length : 255, required : False}, {name : 'existingvcenterid', description : 'UUID of a linked existing vCenter', type : 'uuid', length : 255, required : False, related : ''}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'cpucorepersocket', description : 'The CPU cores per socket for the Instance. VMware specific', type : 'integer'}, {name : 'osid', description : 'The operating system ID of the Instance', type : 'string'}, {name : 'bootmode', description : 'indicates the boot mode', type : 'string'}, {name : 'hostname', description : 'The name of the host to which Instance belongs', type : 'string'}, {name : 'powerstate', description : 'The power state of the Instance', type : 'string'}, {name : 'clustername', description : 'the name of the cluster to which virtual machine belongs', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor to which Instance belongs', type : 'string'}, {name : 'osdisplayname', description : 'The operating system of the Instance', type : 'string'}, {name : 'hostid', description : 'The ID of the host to which Instance belongs', type : 'string'}, {name : 'cpunumber', description : 'The CPU cores of the Instance', type : 'integer'}, {name : 'cpuspeed', description : 'The CPU speed of the Instance', type : 'integer'}, {}, {name : 'memory', description : 'The memory of the Instance in MB', type : 'integer'}, {name : 'hypervisorversion', description : 'The hypervisor version of the host to which Instance belongs', type : 'string'}, {name : 'disk', description : 'The list of disks associated with the Instance', type : 'set', response : [{name : 'controller', description : 'The controller of the disk', type : 'string'}, {name : 'controllerunit', description : 'The controller unit of the disk', type : 'integer'}, {name : 'capacity', description : 'The capacity of the disk in bytes', type : 'long'}, {name : 'imagepath', description : 'The file path of the disk image', type : 'string'}, {name : 'datastorename', description : 'The controller of the disk', type : 'string'}, {name : 'id', description : 'The ID of the disk', type : 'string'}, {name : 'label', description : 'The label of the disk', type : 'string'}, {name : 'datastorepath', description : 'The controller of the disk', type : 'string'}, {name : 'position', description : 'The position of the disk', type : 'integer'}, {name : 'datastoretype', description : 'The controller of the disk', type : 'string'}, {name : 'datastorehost', description : 'The controller of the disk', type : 'string'}]}, {name : 'boottype', description : 'indicates the boot type', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with the Instance', type : 'set', response : [{name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}]}, {name : 'clusterid', description : 'The ID of the cluster to which Instance belongs', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'getUserKeys', description : 'Queries the last registered secret and API keys of a user.', since : '4.10.0', isasync : False, related : '', params : [{name : 'id', description : 'ID of the user whose keys are required', type : 'uuid', length : 255, required : True, related : 'disableUser,getUser,listUsers,lockUser'}], response : [{name : 'secretkey', description : 'The secret key of the registered user', type : 'string'}, {}, {}, {name : 'apikeyaccess', description : 'Whether API key access is allowed or not', type : 'boolean'}, {name : 'apikey', description : 'The API key of the registered user', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'rotateKMSKey', description : 'Rotates KMS key (KEK) by creating new version and scheduling gradual re-encryption', since : '4.23.0', isasync : True, related : 'queryAsyncJobResult', params : [{name : 'hsmprofileid', description : 'The target HSM profile ID for the new KEK version. If provided, migrates the key to this HSM.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'keybits', description : 'Key size for new KEK (default: same as current)', type : 'integer', length : 255, required : False}, {name : 'id', description : 'KMS Key UUID to rotate', type : 'uuid', length : 255, required : True, related : 'createKMSKey,updateKMSKey'}], response : [{name : 'jobresultcode', description : 'The result code for the job', type : 'integer'}, {name : 'created', description : 'The created date of the job', type : 'date'}, {name : 'domainid', description : 'The domain ID that executed the async command', type : 'string'}, {}, {name : 'completed', description : 'The completed date of the job', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'accountid', description : 'The Account ID that executed the async command', type : 'string'}, {name : 'jobresult', description : 'The result reason', type : 'responseobject'}, {name : 'jobinstanceid', description : 'The unique ID of the Instance/entity object related to the job', type : 'string'}, {}, {name : 'jobprocstatus', description : 'The progress information of the PENDING job', type : 'integer'}, {name : 'domainpath', description : 'The domain that executed the async command', type : 'string'}, {name : 'managementserverid', description : 'The MSID of the management server on which the job is running', type : 'string'}, {name : 'userid', description : 'The User that executed the async command', type : 'string'}, {name : 'cmd', description : 'The async command executed', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobinstancetype', description : 'The Instance/entity object related to the job', type : 'string'}, {name : 'managementservername', description : 'the management server name of the host', type : 'string'}, {name : 'account', description : 'The Account that executed the async command', type : 'string'}, {name : 'jobresulttype', description : 'The result type', type : 'string'}], httprequesttype : 'POST'}, {name : 'changeSharedFileSystemServiceOffering', description : 'Change Service offering of a Shared FileSystem', since : '4.20.0', isasync : True, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering', params : [{name : 'serviceofferingid', description : 'the offering to use for the shared filesystem instance', type : 'uuid', length : 255, required : True, related : 'updateServiceOffering,listServiceOfferings'}, {name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}], response : [{name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}]}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}], httprequesttype : 'POST'}, {name : 'cloudianIsEnabled', description : 'Checks if the Cloudian Connector is enabled', since : '4.11.0', isasync : False, related : '', params : [], response : [{name : 'enabled', description : 'The Cloudian connector enabled state', type : 'boolean'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'url', description : 'The Cloudian Management Console base URL', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], httprequesttype : 'GET'}, {name : 'copySnapshot', description : 'Copies a snapshot from one zone to another.', since : '4.19.0', isasync : True, related : 'listSnapshots', params : [{name : 'sourcezoneid', description : "The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used.", type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'storageids', description : 'A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present. Currently supported for StorPool only', type : 'list', length : 255, required : False, since : '4.21.0', related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool'}, {name : 'id', description : 'the ID of the snapshot.', type : 'uuid', length : 255, required : True, related : 'copySnapshot,listSnapshots'}, {name : 'destzoneid', description : 'The ID of the zone the snapshot is being copied to.', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'destzoneids', description : 'A comma-separated list of IDs of the zones that the snapshot needs to be copied to. Specify this list if the snapshot needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.', type : 'list', length : 255, required : False, related : 'listZones'}, {name : 'usestoragereplication', description : "Enables the snapshot to be copied to the supported primary storages when the config 'use.storage.replication' is set to true for the storage or globally. This is supported only for StorPool storage for now.", type : 'boolean', length : 255, required : False, since : '4.21.0'}], response : [{name : 'status', description : 'the status of the template', type : 'string'}, {name : 'snapshottype', description : 'The type of the Snapshot', type : 'string'}, {name : 'virtualsize', description : 'Virtual size of backedup Snapshot on image store', type : 'long'}, {name : 'locationtype', description : 'Valid location types are primary and secondary.', type : 'string'}, {name : 'datastoreid', description : 'ID of the datastore for the snapshot entry', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'volumename', description : 'Name of the disk volume', type : 'string'}, {name : 'ostypeid', description : 'ID of the os on volume', type : 'string'}, {name : 'account', description : 'The Account associated with the Snapshot', type : 'string'}, {name : 'downloaddetails', description : 'download progress of a snapshot', type : 'map'}, {name : 'datastorename', description : 'name of the datastore for the snapshot entry', type : 'string'}, {name : 'domainpath', description : "path of the Domain the snapshot's account belongs to", type : 'string'}, {name : 'created', description : 'The date the Snapshot was created', type : 'date'}, {name : 'parent', description : 'The parent ID of the Snapshot', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'Name of the Snapshot', type : 'string'}, {name : 'parentname', description : 'The parent name of the Snapshot', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}]}, {name : 'state', description : 'The state of the Snapshot. BackedUp means that Snapshot is ready to be used; Creating - the Snapshot is being allocated on the primary storage; BackingUp - the Snapshot is being backed up on secondary storage', type : 'state'}, {name : 'domain', description : "The domain name of the Snapshot's Account", type : 'string'}, {name : 'intervaltype', description : 'Valid types are hourly, daily, weekly, monthy, Template, and none.', type : 'string'}, {name : 'zonename', description : 'name of the availability zone', type : 'string'}, {}, {name : 'id', description : 'ID of the Snapshot', type : 'string'}, {}, {name : 'datastorestate', description : 'state of the snapshot on the datastore', type : 'string'}, {name : 'project', description : 'The project name of the Snapshot', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'domainid', description : "The domain ID of the Snapshot's Account", type : 'string'}, {name : 'chainsize', description : 'chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true', type : 'long'}, {name : 'volumeid', description : 'ID of the disk volume', type : 'string'}, {name : 'projectid', description : 'The project id of the Snapshot', type : 'string'}, {name : 'physicalsize', description : 'Physical size of backed up Snapshot on image store', type : 'long'}, {name : 'volumestate', description : 'state of the disk volume', type : 'string'}, {name : 'revertable', description : 'Indicates whether the underlying storage supports reverting the volume to this Snapshot', type : 'boolean'}, {name : 'osdisplayname', description : 'Display name of the os on volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'datastoretype', description : 'type of the datastore for the snapshot entry', type : 'string'}, {name : 'volumetype', description : 'Type of the disk volume', type : 'string'}], httprequesttype : 'POST'}, {name : 'createDnsRecord', description : 'Creates a DNS record directly on the provider', since : '4.23.0', isasync : True, related : '', params : [{name : 'type', description : 'DNS record type (e.g., A, AAAA, CNAME, MX, TXT, etc.)', type : 'string', length : 255, required : True}, {name : 'name', description : 'DNS record name', type : 'string', length : 255, required : True}, {name : 'ttl', description : 'Time to live', type : 'integer', length : 255, required : False}, {name : 'dnszoneid', description : 'ID of the DNS zone', type : 'uuid', length : 255, required : True, related : ''}, {name : 'contents', description : 'The content of the record (IP address for A/AAAA, FQDN for CNAME/NS, quoted string for TXT, etc.)', type : 'list', length : 255, required : True}], response : [{name : 'contents', description : 'The contents of the record (IP address or target)', type : 'list'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'name', description : 'The record name (e.g., www.example.com.)', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'ttl', description : 'Time to live (TTL) in seconds', type : 'integer'}, {}, {name : 'type', description : 'The record type (e.g., A, CNAME, TXT)', type : 'recordtype'}], httprequesttype : 'POST'}, {name : 'listSharedFileSystems', description : 'List Shared FileSystems', since : '4.20.0', isasync : False, related : 'changeSharedFileSystemDiskOffering', params : [{name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : False, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering'}, {name : 'zoneid', description : 'the ID of the availability zone', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", type : 'boolean', length : 255, required : False}, {name : 'networkid', description : 'the ID of the network', type : 'uuid', length : 255, required : False, related : 'createNetwork,updateNetwork,listNetworks,migrateNetwork'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'diskofferingid', description : 'the disk offering of the shared filesystem', type : 'uuid', length : 255, required : False, related : ''}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'the name of the shared filesystem', type : 'string', length : 255, required : False}, {name : 'serviceofferingid', description : 'the service offering of the shared filesystem', type : 'uuid', length : 255, required : False, related : 'updateServiceOffering,listServiceOfferings'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}], response : [{name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}]}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}], httprequesttype : 'GET'}, {name : 'deleteWebhook', description : 'Deletes a Webhook', since : '4.20.0', isasync : False, params : [{name : 'id', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : True, related : 'createWebhook,updateWebhook'}], response : [{}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'startSystemVm', description : 'Starts a System VM.', isasync : True, related : '', params : [{name : 'id', description : 'The ID of the System VM', type : 'uuid', length : 255, required : True, related : 'startSystemVm'}], response : [{name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'registerVnfTemplate', description : 'Registers an existing VNF template into the CloudStack cloud. ', since : '4.19.0', isasync : False, related : 'registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate', params : [{name : 'bits', description : '32 or 64 bits support. 64 by default', type : 'integer', length : 255, required : False}, {name : 'vnfnics', description : 'VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue.  Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC', type : 'map', length : 255, required : False}, {name : 'name', description : 'The name of the Template', type : 'string', length : 255, required : True}, {name : 'displaytext', description : "The display text of the Template, defaults to 'name'.", type : 'string', length : 4096, required : False}, {name : 'requireshvm', description : 'True if this Template requires HVM', type : 'boolean', length : 255, required : False}, {name : 'ostypeid', description : 'The ID of the OS Type that best represents the OS of this Template. Not applicable with VMware, as we honour what is defined in the Template', type : 'uuid', length : 255, required : False, related : ''}, {name : 'vnfdetails', description : 'VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0', type : 'map', length : 255, required : False}, {name : 'deployasis', description : '(VMware only) true if Instance deployments should preserve all the configurations defined for this Template', type : 'boolean', length : 255, required : False, since : '4.15.1'}, {name : 'passwordenabled', description : 'True if the Template supports the password reset feature; default is false', type : 'boolean', length : 255, required : False}, {name : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance cpu/memory', type : 'boolean', length : 255, required : False}, {name : 'url', description : 'The URL of where the Template is hosted. Possible URL include http:// and https://', type : 'string', length : 2048, required : True}, {name : 'hypervisor', description : 'The target hypervisor for the Template', type : 'string', length : 255, required : True}, {name : 'isrouting', description : 'True if the Template type is routing i.e., if Template is used to deploy router', type : 'boolean', length : 255, required : False}, {name : 'zoneid', description : 'The ID of the zone the Template is to be hosted on', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'templatetype', description : 'the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).', type : 'string', length : 255, required : False, since : '4.19.0'}, {name : 'domainid', description : 'An optional domainId. If the account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'projectid', description : 'Register Template for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'details', description : 'Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61', type : 'map', length : 255, required : False}, {name : 'isextractable', description : 'True if the Template or its derivatives are extractable; default is false', type : 'boolean', length : 255, required : False}, {name : 'format', description : 'The format for the Template. Possible values include QCOW2, RAW, VHD and OVA.', type : 'string', length : 255, required : True}, {name : 'extensionid', description : 'ID of the extension', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listExtensions'}, {name : 'directdownload', description : 'True if Template should bypass Secondary Storage and be downloaded to Primary Storage on deployment', type : 'boolean', length : 255, required : False}, {name : 'checksum', description : 'The checksum value of this Template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.', type : 'string', length : 255, required : False}, {name : 'templatetag', description : 'The tag for this Template.', type : 'string', length : 255, required : False}, {name : 'arch', description : 'the CPU arch of the template. Valid options are: x86_64, aarch64, s390x', type : 'string', length : 255, required : False, since : '4.20'}, {name : 'zoneids', description : 'A list of zone IDs where the Template will be hosted. Use this parameter if the Template needs to be registered to multiple zones in one go. Use zoneid if the Template needs to be registered to only one zone.Passing only -1 to this will cause the Template to be registered as a cross zone Template and will be copied to all zones. ', type : 'list', length : 255, required : False, related : 'listZones'}, {name : 'ispublic', description : 'True if the Template is available to all accounts; default is true', type : 'boolean', length : 255, required : False}, {name : 'account', description : 'An optional accountName. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'forcks', description : 'if true, the templates would be available for deploying CKS clusters', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'sshkeyenabled', description : 'True if the Template supports the sshkey upload feature; default is false', type : 'boolean', length : 255, required : False}, {name : 'externaldetails', description : 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean', length : 255, required : False}], response : [{name : 'name', description : 'The Template name', type : 'string'}, {name : 'extensionid', description : 'The ID of extension linked to this template', type : 'string'}, {name : 'crossZones', description : 'True if the Template is managed across all Zones, false otherwise', type : 'boolean'}, {name : 'parenttemplateid', description : 'If Datadisk Template, then id of the root disk Template this Template belongs to', type : 'string'}, {name : 'size', description : 'The size of the Template', type : 'long'}, {name : 'accountid', description : 'The Account id to which the Template belongs', type : 'string'}, {name : 'account', description : 'The Account name to which the Template belongs', type : 'string'}, {}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', type : 'string'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {name : 'url', description : 'The URL which the Template/ISO is registered from', type : 'string'}, {name : 'userdataparams', description : 'List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'domain', description : 'The name of the domain to which the Template belongs', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'id', description : 'The Template ID', type : 'string'}, {name : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}, {name : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'hostname', description : 'The name of the secondary storage host for the Template', type : 'string'}, {name : 'userdataname', description : 'The name of userdata linked to this Template', type : 'string'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}, {name : 'zonename', description : 'The name of the zone for this Template', type : 'string'}, {name : 'userdataid', description : 'The id of userdata linked to this Template', type : 'string'}, {name : 'directdownload', description : 'KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage', type : 'boolean'}, {name : 'bits', description : 'The processor bit size', type : 'int'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'project', description : 'The project name of the Template', type : 'string'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {name : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean'}, {name : 'passwordenabled', description : 'True if the reset password feature is enabled, false otherwise', type : 'boolean'}, {name : 'checksum', description : 'Checksum of the Template', type : 'string'}, {}, {name : 'isextractable', description : 'True if the Template is extractable, false otherwise', type : 'boolean'}, {name : 'templatetag', description : 'The tag of this Template', type : 'string'}, {name : 'arch', description : 'CPU Arch of the template', type : 'string'}, {name : 'extensionname', description : 'The name of extension linked to this template', type : 'string'}, {name : 'domainid', description : 'The ID of the domain to which the Template belongs', type : 'string'}, {name : 'deployasis', description : 'VMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.', type : 'boolean'}, {}, {name : 'templatetype', description : 'The type of the Template', type : 'string'}, {name : 'ostypeid', description : 'The ID of the OS type for this Template.', type : 'string'}, {name : 'sourcetemplateid', description : 'The Template ID of the parent Template if present', type : 'string'}, {name : 'removed', description : 'The date this Template was removed', type : 'date'}, {name : 'format', description : 'The format of the Template.', type : 'imageformat'}, {name : 'sshkeyenabled', description : 'True if Template is sshkey enabled, false otherwise', type : 'boolean'}, {name : 'requireshvm', description : 'True if Template requires HVM enabled, false otherwise', type : 'boolean'}, {name : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'ispublic', description : 'True if this Template is a public Template, false otherwise', type : 'boolean'}, {name : 'isready', description : 'True if the Template is ready to be deployed from, false otherwise.', type : 'boolean'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'status', description : 'The status of the Template', type : 'string'}, {name : 'hostid', description : 'The ID of the secondary storage host for the Template', type : 'string'}, {name : 'displaytext', description : 'The Template display text', type : 'string'}], httprequesttype : 'POST'}, {name : 'listVirtualMachinesUsageHistory', description : 'Lists VM stats', since : '4.17', isasync : False, related : 'listSystemVmsUsageHistory', params : [{name : 'ids', description : 'The IDs of the Instances, mutually exclusive with id.', type : 'list', length : 255, required : False, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'name', description : 'Name of the Instance (a substring match is made against the parameter value returning the data for all matching Instances).', type : 'string', length : 255, required : False}, {name : 'enddate', description : 'End date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'startdate', description : 'Start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'id', description : 'The ID of the Instance.', type : 'uuid', length : 255, required : False, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'stats', description : 'The list of Instance stats', type : 'list', response : [{name : 'diskioread', description : "The Instance's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", type : 'long'}, {name : 'diskiowrite', description : "The Instance's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", type : 'long'}, {name : 'cpuused', description : "The amount (percentage) of the Instance's CPU currently used", type : 'string'}, {name : 'networkread', description : 'The amount of downloaded data by the Instance in MiB', type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KB', type : 'long'}, {name : 'diskiopstotal', description : 'The total disk IOPS since the last stats retrieval', type : 'long'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'memoryintfreekbs', description : "The Instance's free memory in KB or -1 if it cannot be gathered", type : 'long'}, {name : 'timestamp', description : "The time when the Instance stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'", type : 'date'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KB)', type : 'long'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'networkwrite', description : 'The amount of uploaded data by the Instance in MiB', type : 'string'}]}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'name', description : 'The Name of the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}], httprequesttype : 'GET'}, {name : 'createKubernetesCluster', description : 'Creates a Kubernetes cluster', isasync : True, related : 'startKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'dockerregistrypassword', description : 'Password for the docker image private registry', type : 'string', length : 255, required : False}, {name : 'name', description : 'Name for the Kubernetes cluster', type : 'string', length : 255, required : True}, {name : 'hypervisor', description : 'the hypervisor on which the CKS cluster is to be deployed. This is required if the zone in which the CKS cluster is being deployed has clusters with different hypervisor types.', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'zoneid', description : 'Availability zone in which Kubernetes cluster to be launched', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'dockerregistryurl', description : 'URL for the docker image private registry', type : 'string', length : 255, required : False}, {name : 'kubernetesversionid', description : 'Kubernetes version with which cluster to be launched', type : 'uuid', length : 255, required : False, related : 'getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions'}, {name : 'masternodes', description : "Number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", type : 'long', length : 255, required : False}, {name : 'domainid', description : 'An optional domainId for the Instance. If the Account parameter is used, domainId must also be used. Hosts dedicated to the specified domain will be used for deploying the cluster', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'etcdnodes', description : '(Optional) Number of Kubernetes cluster etcd nodes, default is 0.In case the number is greater than 0, etcd nodes are separate from master nodes and are provisioned accordingly', type : 'long', length : 255, required : False, since : '4.21.0'}, {name : 'nodeaffinitygroups', description : '(Optional) Node Type to Affinity Group ID mapping. If provided, VMs of each node type will be added to the specified affinity group', type : 'map', length : 255, required : False, since : '4.23.0'}, {name : 'projectid', description : 'Deploy cluster for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'keypair', description : 'Name of the SSH key pair used to login to the Instances', type : 'string', length : 255, required : False}, {name : 'nodeofferings', description : '(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'cniconfigdetails', description : 'used to specify the parameters values for the variables in userdata. Example: cniconfigdetails[0].key=accesskey&cniconfigdetails[0].value=s389ddssaa&cniconfigdetails[1].key=secretkey&cniconfigdetails[1].value=8dshfsss', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'asnumber', description : 'the AS Number of the network', type : 'long', length : 255, required : False}, {name : 'dockerregistryusername', description : 'User name for the docker image private registry', type : 'string', length : 255, required : False}, {name : 'cniconfigurationid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.21.0', related : ''}, {name : 'externalloadbalanceripaddress', description : 'External load balancer IP address while using shared network with Kubernetes HA cluster', type : 'string', length : 255, required : False}, {name : 'nodetemplates', description : '(Optional) Node Type to Template ID mapping. If provided, it overrides the default template: System VM template', type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'noderootdisksize', description : 'Root disk size in GB for each node', type : 'long', length : 255, required : False}, {name : 'size', description : 'Number of Kubernetes cluster worker nodes', type : 'long', length : 255, required : False}, {name : 'networkid', description : 'Network in which Kubernetes cluster is to be launched', type : 'uuid', length : 255, required : False, related : 'createNetwork,updateNetwork,listNetworks,migrateNetwork'}, {name : 'account', description : 'An optional Account for the Instance. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'description', description : 'Description for the Kubernetes cluster', type : 'string', length : 255, required : False}, {name : 'enablecsi', description : 'if true, setups up CloudStack CSI driver', type : 'boolean', length : 255, required : False, since : '4.22.0'}, {name : 'serviceofferingid', description : 'The ID of the service offering for the Instances in the cluster.', type : 'uuid', length : 255, required : False, related : 'updateServiceOffering,listServiceOfferings'}, {name : 'controlnodes', description : 'Number of Kubernetes cluster control nodes, default is 1', type : 'long', length : 255, required : False}, {name : 'clustertype', description : 'Type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.', type : 'string', length : 255, required : False, since : '4.19.0'}], response : [{name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}], httprequesttype : 'POST'}, {name : 'updateVMAffinityGroup', description : 'Updates the affinity/anti-affinity group associations of an Instance. The Instance has to be stopped and restarted for the new properties to take effect.', isasync : True, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm', params : [{name : 'affinitygroupids', description : 'Comma separated list of affinity groups id that are going to be applied to the Instance. Should be passed only when Instance is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter', type : 'list', length : 255, required : False, related : ''}, {name : 'affinitygroupnames', description : 'Comma separated list of affinity groups names that are going to be applied to the Instance. Should be passed only when Instance is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter', type : 'list', length : 255, required : False, related : ''}, {name : 'id', description : 'The ID of the Instance', type : 'uuid', length : 255, required : True, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}], response : [{name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}]}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}]}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}, {name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'name', description : 'The name of the attached ISO', type : 'string'}]}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}]}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'value', description : 'Tag value', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}]}, {name : 'projectid', description : 'The project id of the group', type : 'string'}]}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}]}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}], httprequesttype : 'POST'}, {name : 'updateWebhook', description : 'Updates a Webhook', since : '4.20.0', isasync : False, related : 'createWebhook', params : [{name : 'payloadurl', description : 'Payload URL of the Webhook', type : 'string', length : 255, required : False}, {name : 'scope', description : 'Scope of the Webhook', type : 'string', length : 255, required : False}, {name : 'sslverification', description : 'If set to true then SSL verification will be done for the Webhook otherwise not', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'Name for the Webhook', type : 'string', length : 255, required : False}, {name : 'description', description : 'Description for the Webhook', type : 'string', length : 255, required : False}, {name : 'state', description : 'State of the Webhook', type : 'string', length : 255, required : False}, {name : 'secretkey', description : 'Secret key of the Webhook', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : True, related : 'createWebhook,updateWebhook'}], response : [{name : 'secretkey', description : 'The secret key for the Webhook', type : 'string'}, {name : 'description', description : 'The description of the Webhook', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'projectid', description : 'the project id of the Kubernetes cluster', type : 'string'}, {name : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}, {name : 'account', description : 'The account associated with the Webhook', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Webhook exists', type : 'string'}, {name : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {name : 'project', description : 'the project name of the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Webhook exists', type : 'string'}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {name : 'created', description : 'The date when this Webhook was created', type : 'date'}], httprequesttype : 'POST'}, {name : 'listCaCertificate', description : 'Lists the CA public certificate(s) as support by the configured/provided CA plugin', since : '4.11.0', isasync : False, related : '', params : [{name : 'provider', description : 'Name of the CA service provider, otherwise the default configured provider plugin will be used', type : 'string', length : 255, required : False}], response : [{name : 'privatekey', description : 'Private key for the certificate', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'cacertificates', description : 'The CA certificate(s)', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'certificate', description : 'The client certificate', type : 'string'}, {}], httprequesttype : 'GET'}, {name : 'updateProjectRole', description : 'Creates a Project role', since : '4.15.0', isasync : False, related : '', params : [{name : 'projectid', description : 'ID of project where role is being created', type : 'uuid', length : 255, required : True, related : ''}, {name : 'description', description : 'The description of the Project role', type : 'string', length : 255, required : False}, {name : 'id', description : 'ID of the Project role', type : 'uuid', length : 255, required : True, related : 'updateProjectRole'}, {name : 'name', description : 'Creates a project role with this unique name', type : 'string', length : 255, required : False}], response : [{name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'description', description : 'The description of the role', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'The name of the role', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'id', description : 'The ID of the role', type : 'string'}, {name : 'ispublic', description : 'Indicates whether the role will be visible to all Users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listImportVmTasks', description : 'List running import virtual machine tasks from a unmanaged hosts into CloudStack', since : '4.22', isasync : False, related : '', params : [{name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'tasksfilter', description : 'Filter tasks by state, valid options are: All, Running, Completed, Failed', type : 'string', length : 255, required : False}, {name : 'convertinstancehostid', description : 'Conversion host of the importing task', type : 'uuid', length : 255, required : False, related : 'reconnectHost'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'vcenter', description : 'The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.', type : 'string', length : 255, required : False}, {name : 'accountid', description : 'the ID of the Account', type : 'uuid', length : 255, required : False, related : 'enableAccount,listAccounts'}], response : [{name : 'description', description : 'the current step description on the importing VM task', type : 'string'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'virtualmachineid', description : 'the ID of the imported VM (after task is completed)', type : 'string'}, {name : 'displayname', description : 'the display name of the importing VM', type : 'string'}, {name : 'convertinstancehostname', description : 'the name of the host on which the instance is being converted', type : 'string'}, {name : 'state', description : 'the state of the importing VM task', type : 'string'}, {name : 'duration', description : 'the total task duration', type : 'string'}, {name : 'convertinstancehostid', description : 'the ID of the host on which the instance is being converted', type : 'string'}, {name : 'accountid', description : 'the ID of account', type : 'string'}, {name : 'created', description : 'the create date of the importing task', type : 'date'}, {name : 'stepduration', description : 'the duration of the current step', type : 'string'}, {name : 'zonename', description : 'the Zone name', type : 'string'}, {name : 'step', description : 'the current step on the importing VM task', type : 'string'}, {name : 'vcenter', description : 'the vcenter name of the importing VM task', type : 'string'}, {name : 'lastupdated', description : 'the last updated date of the importing task', type : 'date'}, {}, {name : 'id', description : 'the ID of importing task', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'sourcevmname', description : 'the source VM name', type : 'string'}, {name : 'zoneid', description : 'the Zone ID', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'datacentername', description : 'the datacenter name of the importing VM task', type : 'string'}], httprequesttype : 'GET'}, {name : 'changeSharedFileSystemDiskOffering', description : 'Change Disk offering of a Shared FileSystem', since : '4.20.0', isasync : True, related : '', params : [{name : 'maxiops', description : 'max iops', type : 'long', length : 255, required : False}, {name : 'miniops', description : 'min iops', type : 'long', length : 255, required : False}, {name : 'size', description : 'the size of the shared filesystem in GiB', type : 'long', length : 255, required : False}, {name : 'diskofferingid', description : 'the disk offering to use for the underlying storage', type : 'uuid', length : 255, required : False, related : ''}, {name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'changeSharedFileSystemDiskOffering'}], response : [{name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}]}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}]}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}], httprequesttype : 'POST'}, {name : 'createKMSKey', description : 'Creates a new KMS key (Key Encryption Key) for encryption', since : '4.23.0', isasync : False, related : 'updateKMSKey', params : [{name : 'name', description : 'Name of the KMS key', type : 'string', length : 255, required : True}, {name : 'description', description : 'Description of the KMS key', type : 'string', length : 255, required : False}, {name : 'keybits', description : 'Key size in bits: 128, 192, or 256 (default: 256)', type : 'integer', length : 255, required : False}, {name : 'projectid', description : 'ID of the project to create the KMS key for', type : 'uuid', length : 255, required : False, related : ''}, {name : 'account', description : 'Account name (for creating keys for child accounts - requires domain admin or admin)', type : 'string', length : 255, required : False}, {name : 'hsmprofileid', description : 'ID of HSM profile to create key in', type : 'uuid', length : 255, required : True, related : ''}, {name : 'domainid', description : 'Domain ID (for creating keys for child accounts - requires domain admin or admin)', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'zoneid', description : 'Zone ID where the key will be valid', type : 'uuid', length : 255, required : True, related : 'listZones'}], response : [{name : 'domainid', description : 'the domain ID of the key', type : 'string'}, {name : 'projectid', description : 'the project ID of the key', type : 'string'}, {}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainpath', description : 'the domain path of the key', type : 'string'}, {name : 'hsmprofile', description : 'the zone name where the key is valid', type : 'string'}, {name : 'name', description : 'the name of the key', type : 'string'}, {name : 'account', description : 'the account owning the key', type : 'string'}, {name : 'enabled', description : 'whether the key is enabled', type : 'boolean'}, {name : 'zonename', description : 'the zone name where the key is valid', type : 'string'}, {name : 'algorithm', description : 'the encryption algorithm', type : 'string'}, {name : 'accountid', description : 'the account ID owning the key', type : 'string'}, {name : 'domain', description : 'the domain name of the key', type : 'string'}, {name : 'keklabel', description : 'the provider-specific KEK label (admin only)', type : 'string'}, {name : 'description', description : 'the description of the key', type : 'string'}, {name : 'hsmprofileid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'created', description : 'the creation timestamp', type : 'date'}, {name : 'id', description : 'the UUID of the key', type : 'string'}, {name : 'keybits', description : 'the key size in bits', type : 'integer'}, {name : 'zoneid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'version', description : 'the key size in bits', type : 'integer'}, {name : 'project', description : 'the project name of the key', type : 'string'}], httprequesttype : 'POST'}, {name : 'expungeSharedFileSystem', description : 'Expunge a Shared FileSystem by id', since : '4.20.0', isasync : True, params : [{name : 'id', description : 'the ID of the shared filesystem to expunge', type : 'uuid', length : 255, required : False, related : ''}], response : [{}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'getUploadParamsForTemplate', description : 'Upload an existing Template into the CloudStack cloud. ', since : '4.6.0', isasync : False, related : 'getUploadParamsForIso', params : [{name : 'name', description : 'The name of the Volume/Template/ISO', type : 'string', length : 255, required : True}, {name : 'deployasis', description : '(VMware only) true if Instance deployments should preserve all the configurations defined for this Template', type : 'boolean', length : 255, required : False, since : '4.15.1'}, {name : 'templatetag', description : 'The tag for this Template.', type : 'string', length : 255, required : False}, {name : 'sshkeyenabled', description : 'True if the Template supports the SSHkey upload feature; default is false', type : 'boolean', length : 255, required : False}, {name : 'ostypeid', description : 'The ID of the OS Type that best represents the OS of this Template. Not required for VMware as the guest OS is obtained from the OVF file.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'projectid', description : 'Upload Volume/Template/ISO for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'account', description : 'An optional accountName. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean', length : 255, required : False}, {name : 'hypervisor', description : 'The target hypervisor for the Template', type : 'string', length : 255, required : True}, {name : 'templatetype', description : 'the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).', type : 'string', length : 255, required : False, since : '4.22.0'}, {name : 'ispublic', description : 'True if the Template is available to all accounts; default is true', type : 'boolean', length : 255, required : False}, {name : 'passwordenabled', description : 'True if the Template supports the password reset feature; default is false', type : 'boolean', length : 255, required : False}, {name : 'bits', description : '32 or 64 bits support. 64 by default', type : 'integer', length : 255, required : False}, {name : 'displaytext', description : 'The display text of the Template. This is usually used for display purposes.', type : 'string', length : 4096, required : False}, {name : 'arch', description : 'the CPU arch of the template. Valid options are: x86_64, aarch64, s390x', type : 'string', length : 255, required : False, since : '4.20'}, {name : 'checksum', description : 'The checksum value of this Volume/Template/ISO The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.', type : 'string', length : 255, required : False}, {name : 'format', description : 'The format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.', type : 'string', length : 255, required : True}, {name : 'forcks', description : 'if true, the templates would be available for deploying CKS clusters', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'details', description : 'Template details in key/value pairs.', type : 'map', length : 255, required : False}, {name : 'zoneid', description : 'The ID of the zone the Volume/Template/ISO is to be hosted on', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'isrouting', description : 'True if the Template type is routing i.e., if Template is used to deploy router', type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'An optional domainId. If the Account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean', length : 255, required : False}, {name : 'isextractable', description : 'True if the Template or its derivatives are extractable; default is false', type : 'boolean', length : 255, required : False}, {name : 'requireshvm', description : 'True if this Template requires HVM', type : 'boolean', length : 255, required : False}], response : [{name : 'signature', description : 'Signature to be sent in the POST request.', type : 'string'}, {name : 'id', description : 'The Template/volume ID', type : 'uuid'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'metadata', description : 'Encrypted data to be sent in the POST request.', type : 'string'}, {name : 'expires', description : 'The timestamp after which the signature expires', type : 'string'}, {name : 'postURL', description : 'POST url to upload the file to', type : 'url'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'listAutoScaleVmProfiles', description : 'Lists autoscale Instance profiles.', isasync : False, related : '', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'zoneid', description : 'Availability zone for the auto deployed Instance', type : 'uuid', length : 255, required : False, since : '4.4', related : 'listZones'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'otherdeployparams', description : 'The otherdeployparameters of the autoscale Instance profile', type : 'string', length : 255, required : False}, {name : 'templateid', description : 'The templateid of the autoscale Instance profile', type : 'uuid', length : 255, required : False, related : 'registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'id', description : 'The ID of the autoscale Instance profile', type : 'uuid', length : 255, required : False, related : 'listAutoScaleVmProfiles'}, {name : 'fordisplay', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'serviceofferingid', description : 'List profiles by service offering id', type : 'uuid', length : 255, required : False, since : '4.4', related : 'updateServiceOffering,listServiceOfferings'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}], response : [{name : 'autoscaleuserid', description : 'The ID of the User used to launch and destroy the Instances', type : 'string'}, {name : 'userdataid', description : 'the id of userdata used for the VM', type : 'string'}, {name : 'zoneid', description : 'The availability zone to be used while deploying an Instance', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the vm profile belongs', type : 'string'}, {name : 'serviceofferingid', description : 'The service offering to be used while deploying an Instance', type : 'string'}, {name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance', type : 'map'}, {name : 'fordisplay', description : 'Is profile for display to the regular User', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'userdatapolicy', description : 'the userdata override policy with the userdata provided while deploying VM', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer'}, {name : 'id', description : 'The autoscale Instance profile ID', type : 'string'}, {name : 'userdata', description : 'Base64 encoded Instance user data', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance profile', type : 'string'}, {name : 'templateid', description : 'The Template to be used while deploying an Instance', type : 'string'}, {name : 'projectid', description : 'The project id Instance profile', type : 'string'}, {name : 'userdatadetails', description : 'list of variables and values for the variables declared in userdata', type : 'string'}, {}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'userdataname', description : 'the name of userdata used for the VM', type : 'string'}, {name : 'project', description : 'The project name of the Instance profile', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance profile', type : 'string'}, {}], httprequesttype : 'GET'}, {name : 'updateBucket', description : 'Updates Bucket properties', since : '4.19.0', isasync : False, params : [{name : 'policy', description : 'Bucket Access Policy', type : 'string', length : 255, required : False}, {name : 'versioning', description : 'Enable/Disable Bucket Versioning', type : 'boolean', length : 255, required : False}, {name : 'quota', description : 'Bucket Quota in GiB', type : 'integer', length : 255, required : False}, {name : 'encryption', description : 'Enable/Disable Bucket encryption', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The ID of the Bucket', type : 'uuid', length : 255, required : True, related : ''}], response : [{name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listDnsProviders', description : 'Lists available DNS plugin providers', since : '4.23.0', isasync : False, related : '', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{}, {name : 'name', description : 'The name of the DNS provider (e.g. PowerDNS, Cloudflare)', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'listTungstenFabricVm', description : 'List Tungsten-Fabric vm', isasync : False, related : '', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'vmuuid', description : 'The uuid of Tungsten-Fabric vm', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'The ID of zone', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'uuid', description : 'Tungsten-Fabric nic uuid', type : 'string'}, {}, {}, {name : 'zonename', description : 'Tungsten-Fabric provider zone name', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zoneid', description : 'Tungsten-Fabric provider zone id', type : 'long'}, {name : 'name', description : 'Tungsten-Fabric vm name', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'createWebhook', description : 'Creates a Webhook', since : '4.20.0', isasync : False, related : '', params : [{name : 'name', description : 'Name for the Webhook', type : 'string', length : 255, required : True}, {name : 'secretkey', description : 'Secret key of the Webhook', type : 'string', length : 255, required : False}, {name : 'scope', description : 'Scope of the Webhook', type : 'string', length : 255, required : False}, {name : 'sslverification', description : 'If set to true then SSL verification will be done for the Webhook otherwise not', type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'an optional domainId for the Webhook. If the account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'account', description : 'An optional account for the Webhook. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'state', description : 'State of the Webhook', type : 'string', length : 255, required : False}, {name : 'payloadurl', description : 'Payload URL of the Webhook', type : 'string', length : 255, required : True}, {name : 'description', description : 'Description for the Webhook', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'Project for the Webhook', type : 'uuid', length : 255, required : False, related : ''}], response : [{name : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {name : 'created', description : 'The date when this Webhook was created', type : 'date'}, {}, {name : 'description', description : 'The description of the Webhook', type : 'string'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {name : 'account', description : 'The account associated with the Webhook', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}, {name : 'secretkey', description : 'The secret key for the Webhook', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainid', description : 'The ID of the domain in which the Webhook exists', type : 'string'}, {name : 'projectid', description : 'the project id of the Kubernetes cluster', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Webhook exists', type : 'string'}, {name : 'project', description : 'the project name of the Kubernetes cluster', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'updateKubernetesClusterAffinityGroups', description : 'Updates the affinity group mappings for a stopped Kubernetes cluster', since : '4.23.0', isasync : False, related : 'startKubernetesCluster', params : [{name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'startKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {name : 'nodeaffinitygroups', description : 'Node Type to Affinity Group ID mapping. VMs of each node type will be added to the specified affinity group', type : 'map', length : 255, required : False, since : '4.23.0'}], response : [{name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteResourceSchedule', description : 'Delete Resource Schedule', since : '4.23.0', isasync : False, params : [{name : 'resourceid', description : 'ID of the resource for which schedules are to be deleted', type : 'string', length : 255, required : True}, {name : 'ids', description : 'comma separated list of schedule ids to be deleted', type : 'list', length : 255, required : False, related : ''}, {name : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : True}, {name : 'id', description : 'ID of the schedule to be deleted', type : 'uuid', length : 255, required : False, related : ''}], response : [{}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'listKubernetesSupportedVersions', description : 'Lists supported Kubernetes version', isasync : False, related : 'getUploadParamsForKubernetesSupportedVersion', params : [{name : 'minimumkubernetesversionid', description : 'The ID of the minimum Kubernetes supported version', type : 'uuid', length : 255, required : False, related : 'getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the Kubernetes supported version', type : 'uuid', length : 255, required : False, related : 'getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions'}, {name : 'arch', description : 'the CPU arch of the binaries ISO. Valid options are: x86_64, aarch64, s390x', type : 'string', length : 255, required : False, since : '4.20'}, {name : 'minimumsemanticversion', description : 'The minimum semantic version for the Kubernetes supported version to be listed', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'The ID of the zone in which Kubernetes supported version will be available', type : 'uuid', length : 255, required : False, related : 'listZones'}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zoneid', description : 'The ID of the zone in which Kubernetes supported version is available', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes supported version was created', type : 'date'}, {name : 'isourl', description : 'the URL of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'arch', description : 'the arch of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'supportsautoscaling', description : 'Whether Kubernetes supported version supports Autoscaling', type : 'boolean'}, {name : 'isoid', description : 'The ID of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes supported version', type : 'string'}, {name : 'state', description : 'The enabled or disabled state of the Kubernetes supported version', type : 'string'}, {name : 'supportsha', description : 'Whether Kubernetes supported version supports HA, multi-control nodes', type : 'boolean'}, {name : 'directdownload', description : 'KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage', type : 'boolean'}, {name : 'zonename', description : 'The name of the zone in which Kubernetes supported version is available', type : 'string'}, {}, {}, {name : 'isoname', description : 'The name of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'Name of the Kubernetes supported version', type : 'string'}, {name : 'semanticversion', description : 'Kubernetes semantic version', type : 'string'}, {name : 'mincpunumber', description : 'The minimum number of CPUs needed for the Kubernetes supported version', type : 'integer'}, {name : 'minmemory', description : 'The minimum RAM size in MB needed for the Kubernetes supported version', type : 'integer'}, {name : 'isostate', description : 'The state of the binaries ISO for Kubernetes supported version', type : 'string'}], httprequesttype : 'GET'}, {name : 'recoverVolume', description : 'Recovers a Destroy volume.', since : '4.14.0', isasync : False, related : 'createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume', params : [{name : 'id', description : 'The ID of the volume', type : 'uuid', length : 255, required : True, related : 'createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume'}], response : [{name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'deviceid', description : 'The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.', type : 'long'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {name : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {}, {name : 'vmstate', description : 'State of the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}], httprequesttype : 'POST'}, {name : 'listVnfAppliances', description : 'List VNF appliance owned by the account.', since : '4.19.1', isasync : False, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,importVm', params : [{name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'isvnf', description : 'flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.', type : 'boolean', length : 255, required : False, since : '4.19.0'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'leased', description : 'Whether to return only leased instances', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'id', description : 'The ID of the Instance', type : 'uuid', length : 255, required : False, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string', length : 255, required : False, since : '4.20.1'}, {name : 'groupid', description : 'The group ID', type : 'uuid', length : 255, required : False, related : ''}, {name : 'userid', description : 'The user ID that created the Instance and is under the Account that owns the Instance', type : 'uuid', length : 255, required : False, related : 'getUser'}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", type : 'boolean', length : 255, required : False}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'isoid', description : 'List Instances by ISO', type : 'uuid', length : 255, required : False}, {name : 'hypervisor', description : 'The target hypervisor for the Template', type : 'string', length : 255, required : False}, {name : 'vpcid', description : 'List Instances by VPC', type : 'uuid', length : 255, required : False, related : 'createVPC,listVPCs,updateVPC'}, {name : 'userdata', description : "Whether to return the Instances' User data or not. By default, User data will not be returned.", type : 'boolean', length : 255, required : False, since : '4.18.0.0'}, {name : 'keypair', description : 'List Instances by SSH keypair name', type : 'string', length : 255, required : False}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'templateid', description : 'List Instances by Template', type : 'uuid', length : 255, required : False, related : 'listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'zoneid', description : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,updateNetwork,listNetworks'}, {name : 'name', description : 'Name of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)', type : 'string', length : 255, required : False}, {name : 'displayvm', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'autoscalevmgroupid', description : 'The ID of AutoScaling Instance Group', type : 'uuid', length : 255, required : False, since : '4.18.0', related : ''}, {name : 'serviceofferingid', description : 'List by the service offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'updateServiceOffering,listServiceOfferings'}, {name : 'details', description : 'Comma separated list of Instance details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.', type : 'list', length : 255, required : False}, {name : 'state', description : 'State of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.', type : 'string', length : 255, required : False}, {name : 'gpuenabled', description : 'Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'securitygroupid', description : 'The security group ID', type : 'uuid', length : 255, required : False, since : '4.15', related : ''}, {name : 'haenable', description : 'List by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabled', type : 'boolean', length : 255, required : False, since : '4.15'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'accumulate', description : 'Accumulates the Instance metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.', type : 'boolean', length : 255, required : False, since : '4.17.0'}, {name : 'affinitygroupid', description : 'List Instances by affinity group', type : 'uuid', length : 255, required : False, related : ''}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'userdataid', description : 'the instances by userdata', type : 'uuid', length : 255, required : False, since : '4.20.1', related : ''}, {name : 'ids', description : 'The IDs of the Instances, mutually exclusive with id', type : 'list', length : 255, required : False, since : '4.4', related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'showicon', description : 'Flag to display the resource icon for Instances', type : 'boolean', length : 255, required : False, since : '4.16.0.0'}, {name : 'forvirtualnetwork', description : 'List by Network type; true if need to list Instances using Virtual Network, false otherwise', type : 'boolean', length : 255, required : False}, {name : 'backupofferingid', description : 'List by the backup offering', type : 'uuid', length : 255, required : False, since : '4.17', related : ''}, {name : 'extensionid', description : 'The ID of the Orchestrator extension for the VM', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listExtensions'}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}], response : [{name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}]}, {}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}]}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}]}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}]}]}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}]}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}], httprequesttype : 'GET'}, {name : 'listSystemVmsUsageHistory', description : 'Lists System VM stats', since : '4.18.0', isasync : False, related : '', params : [{name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'enddate', description : 'End date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'id', description : 'The ID of the system VM.', type : 'uuid', length : 255, required : False, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,importVm'}, {name : 'ids', description : 'The IDs of the System VMs, mutually exclusive with ID.', type : 'list', length : 255, required : False, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,importVm'}, {name : 'startdate', description : 'Start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'name', description : 'Name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'stats', description : 'The list of Instance stats', type : 'list', response : [{name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'timestamp', description : "The time when the Instance stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'", type : 'date'}, {name : 'diskioread', description : "The Instance's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", type : 'long'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'diskiopstotal', description : 'The total disk IOPS since the last stats retrieval', type : 'long'}, {name : 'cpuused', description : "The amount (percentage) of the Instance's CPU currently used", type : 'string'}, {name : 'networkread', description : 'The amount of downloaded data by the Instance in MiB', type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KB', type : 'long'}, {name : 'networkwrite', description : 'The amount of uploaded data by the Instance in MiB', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KB)', type : 'long'}, {name : 'diskiowrite', description : "The Instance's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", type : 'long'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'memoryintfreekbs', description : "The Instance's free memory in KB or -1 if it cannot be gathered", type : 'long'}]}, {}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'The Name of the Instance', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}], httprequesttype : 'GET'}, {name : 'deleteIpv6FirewallRule', description : 'Deletes a IPv6 firewall rule', isasync : True, params : [{name : 'id', description : 'The ID of the IPv6 firewall rule', type : 'uuid', length : 255, required : True, related : ''}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'listVMSnapshot', description : 'List Instance Snapshot by conditions', since : '4.2.0', isasync : False, related : 'createVMSnapshot', params : [{name : 'vmsnapshotids', description : 'The IDs of the Instance Snapshots, mutually exclusive with vmsnapshotid', type : 'list', length : 255, required : False, since : '4.9', related : 'listVMSnapshot,createVMSnapshot'}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'Lists Snapshot by Snapshot name or display name', type : 'string', length : 255, required : False}, {name : 'virtualmachineid', description : 'The ID of the Instance', type : 'uuid', length : 255, required : False, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,importVm'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'vmsnapshotid', description : 'The ID of the Instance Snapshot', type : 'uuid', length : 255, required : False, related : 'listVMSnapshot,createVMSnapshot'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'state', description : 'State of the Instance Snapshot', type : 'string', length : 255, required : False}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'id', description : 'The ID of the Instance Snapshot', type : 'string'}, {name : 'current', description : 'Indicates if this is current Snapshot', type : 'boolean'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {}, {name : 'created', description : 'The create date of the Instance Snapshot', type : 'date'}, {name : 'hypervisor', description : 'The type of hypervisor on which Snapshot is stored', type : 'string'}, {name : 'type', description : 'Instance Snapshot type', type : 'string'}, {name : 'state', description : 'The state of the Instance Snapshot', type : 'state'}, {name : 'domainpath', description : 'Path of the domain to which the disk volume belongs', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'parent', description : 'The parent ID of the Instance Snapshot', type : 'string'}, {name : 'name', description : 'The name of the Instance Snapshot', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'zoneid', description : 'The Zone ID of the Instance Snapshot', type : 'string'}, {name : 'zonename', description : 'The Zone name of the Instance Snapshot', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'virtualmachineid', description : 'The Instance ID of the Instance Snapshot', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name of the Instance Snapshot', type : 'string'}, {}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'projectid', description : 'The project ID of the VPN', type : 'string'}, {name : 'displayname', description : 'The display name of the Instance Snapshot', type : 'string'}, {name : 'parentName', description : 'The parent displayName of the Instance Snapshot', type : 'string'}, {name : 'description', description : 'The description of the Instance Snapshot', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateKMSKey', description : 'Updates KMS key name, description, or enabled status', since : '4.23.0', isasync : False, related : '', params : [{name : 'description', description : 'New description for the key', type : 'string', length : 255, required : False}, {name : 'name', description : 'New name for the key', type : 'string', length : 255, required : False}, {name : 'enabled', description : 'whether the key should be enabled', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The UUID of the KMS key to update', type : 'uuid', length : 255, required : True, related : 'updateKMSKey'}], response : [{name : 'domainid', description : 'the domain ID of the key', type : 'string'}, {name : 'account', description : 'the account owning the key', type : 'string'}, {name : 'hsmprofile', description : 'the zone name where the key is valid', type : 'string'}, {name : 'accountid', description : 'the account ID owning the key', type : 'string'}, {name : 'id', description : 'the UUID of the key', type : 'string'}, {name : 'domain', description : 'the domain name of the key', type : 'string'}, {name : 'version', description : 'the key size in bits', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'description', description : 'the description of the key', type : 'string'}, {name : 'domainpath', description : 'the domain path of the key', type : 'string'}, {}, {name : 'projectid', description : 'the project ID of the key', type : 'string'}, {name : 'keklabel', description : 'the provider-specific KEK label (admin only)', type : 'string'}, {name : 'zonename', description : 'the zone name where the key is valid', type : 'string'}, {}, {name : 'project', description : 'the project name of the key', type : 'string'}, {name : 'hsmprofileid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'zoneid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'algorithm', description : 'the encryption algorithm', type : 'string'}, {name : 'enabled', description : 'whether the key is enabled', type : 'boolean'}, {name : 'created', description : 'the creation timestamp', type : 'date'}, {name : 'name', description : 'the name of the key', type : 'string'}, {name : 'keybits', description : 'the key size in bits', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listApis', description : 'Lists all available APIs on the server, provided by the API Discovery plugin', since : '4.1.0', isasync : False, related : '', params : [{name : 'name', description : 'API name', type : 'string', length : 255, required : False}], response : [{name : 'type', description : 'Response field type', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'The name of the API command', type : 'string'}, {name : 'description', description : 'Description of the API', type : 'string'}, {name : 'related', description : 'Comma separated related apis', type : 'string'}, {name : 'params', description : 'The list params the api accepts', type : 'set', response : [{name : 'since', description : 'Version of CloudStack the API was introduced in', type : 'string'}, {}, {name : 'related', description : 'Comma separated related APIs to get the parameter', type : 'string'}, {name : 'name', description : 'The name of the API parameter', type : 'string'}, {name : 'type', description : 'Parameter type', type : 'string'}, {name : 'length', description : 'Length of the parameter', type : 'int'}, {name : 'required', description : 'True if this parameter is required for the API request', type : 'boolean'}, {name : 'description', description : 'Description of the API parameter', type : 'string'}]}, {name : 'response', description : 'API response fields', type : 'set', response : [{name : 'response', description : 'API response fields', type : 'set'}, {name : 'description', description : 'Description of the API response field', type : 'string'}, {name : 'type', description : 'Response field type', type : 'string'}, {name : 'name', description : 'The name of the API response field', type : 'string'}]}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'isasync', description : 'True if API is asynchronous', type : 'boolean'}, {name : 'since', description : 'Version of CloudStack the API was introduced in', type : 'string'}, {name : 'httprequesttype', description : 'Preferred HTTP request type for the API', type : 'string'}], httprequesttype : 'GET'}, {name : 'createVMSnapshot', description : 'Creates Snapshot for an Instance.', since : '4.2.0', isasync : True, related : '', params : [{name : 'name', description : 'The display name of the Snapshot', type : 'string', length : 255, required : False}, {name : 'snapshotmemory', description : 'Snapshot memory if true', type : 'boolean', length : 255, required : False}, {name : 'virtualmachineid', description : 'The ID of the Instance', type : 'uuid', length : 255, required : True, related : 'scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,importVm'}, {name : 'description', description : 'The description of the Snapshot', type : 'string', length : 255, required : False}, {name : 'quiescevm', description : 'Quiesce Instance if true', type : 'boolean', length : 255, required : False}], response : [{}, {name : 'created', description : 'The create date of the Instance Snapshot', type : 'date'}, {name : 'projectid', description : 'The project ID of the VPN', type : 'string'}, {name : 'parentName', description : 'The parent displayName of the Instance Snapshot', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'value', description : 'Tag value', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zoneid', description : 'The Zone ID of the Instance Snapshot', type : 'string'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'hypervisor', description : 'The type of hypervisor on which Snapshot is stored', type : 'string'}, {name : 'current', description : 'Indicates if this is current Snapshot', type : 'boolean'}, {name : 'zonename', description : 'The Zone name of the Instance Snapshot', type : 'string'}, {name : 'name', description : 'The name of the Instance Snapshot', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'state', description : 'The state of the Instance Snapshot', type : 'state'}, {name : 'domainpath', description : 'Path of the domain to which the disk volume belongs', type : 'string'}, {}, {name : 'id', description : 'The ID of the Instance Snapshot', type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID of the Instance Snapshot', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name of the Instance Snapshot', type : 'string'}, {name : 'description', description : 'The description of the Instance Snapshot', type : 'string'}, {name : 'parent', description : 'The parent ID of the Instance Snapshot', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'type', description : 'Instance Snapshot type', type : 'string'}, {name : 'displayname', description : 'The display name of the Instance Snapshot', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'getUploadParamsForIso', description : 'Upload an existing ISO into the CloudStack cloud.', since : '4.13', isasync : False, related : '', params : [{name : 'isextractable', description : 'True if the ISO or its derivatives are extractable; default is false', type : 'boolean', length : 255, required : False}, {name : 'projectid', description : 'Upload Volume/Template/ISO for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'isfeatured', description : 'True if you want this ISO to be featured', type : 'boolean', length : 255, required : False}, {name : 'zoneid', description : 'The ID of the zone the Volume/Template/ISO is to be hosted on', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'format', description : 'The format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.', type : 'string', length : 255, required : True}, {name : 'displaytext', description : 'The display text of the ISO. This is usually used for display purposes.', type : 'string', length : 4096, required : False}, {name : 'account', description : 'An optional accountName. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'name', description : 'The name of the Volume/Template/ISO', type : 'string', length : 255, required : True}, {name : 'domainid', description : 'An optional domainId. If the Account parameter is used, domainId must also be used.', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'bootable', description : 'True if this ISO is bootable. If not passed explicitly its assumed to be true', type : 'boolean', length : 255, required : False}, {name : 'ostypeid', description : 'The ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed', type : 'uuid', length : 255, required : False, related : ''}, {name : 'checksum', description : 'The checksum value of this Volume/Template/ISO The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.', type : 'string', length : 255, required : False}, {name : 'ispublic', description : 'True if you want to register the ISO to be publicly available to all Users, false otherwise.', type : 'boolean', length : 255, required : False}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'postURL', description : 'POST url to upload the file to', type : 'url'}, {name : 'expires', description : 'The timestamp after which the signature expires', type : 'string'}, {name : 'signature', description : 'Signature to be sent in the POST request.', type : 'string'}, {}, {name : 'id', description : 'The Template/volume ID', type : 'uuid'}, {}, {name : 'metadata', description : 'Encrypted data to be sent in the POST request.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'deleteAutoScaleVmGroup', description : 'Deletes an autoscale Instance group.', isasync : True, params : [{name : 'cleanup', description : 'True if all VMs have to be cleaned up, false otherwise', type : 'boolean', length : 255, required : False, since : '4.18.0'}, {name : 'id', description : 'The ID of the autoscale group', type : 'uuid', length : 255, required : True, related : ''}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'listUserKeys', description : 'Lists the API key pairs (API and secret keys) of a user.', since : '4.23.0', isasync : False, related : '', params : [{name : 'userid', description : 'ID of the user that owns the keys.', type : 'uuid', length : 255, required : False, related : 'getUser'}, {name : 'apikeyfilter', description : 'API key of the key pair.', type : 'string', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'listall', description : 'Lists all API key pairs of users that are accessible by the calling account. Only available for administrators. Defaults to false.', type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'showpermissions', description : 'Whether API Key rules should be returned. Defaults to false.', type : 'boolean', length : 255, required : False}, {name : 'keypairid', description : 'ID of the key pair.', type : 'uuid', length : 255, required : False, related : 'listUserKeys'}], response : [{name : 'name', description : 'Name of the API key pair', type : 'string'}, {name : 'description', description : 'API key pair description.', type : 'string'}, {name : 'domain', description : 'Name of the domain which the account belongs to.', type : 'string'}, {name : 'apikey', description : 'The API key of the registered user.', type : 'string'}, {name : 'roleid', description : 'ID of the role.', type : 'string'}, {name : 'rolename', description : 'Name of the role.', type : 'string'}, {name : 'accountname', description : 'Account name.', type : 'string'}, {name : 'state', description : 'State of the API key pair.', type : 'apikeypairstate'}, {name : 'roletype', description : 'Type of the role (Admin, ResourceAdmin, DomainAdmin, User).', type : 'string'}, {name : 'accountid', description : 'Account ID.', type : 'string'}, {name : 'userid', description : 'ID of the user that owns the keypair.', type : 'string'}, {name : 'secretkey', description : 'The secret key of the registered user.', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainpath', description : 'Path of the domain which the account belongs to.', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {}, {name : 'permissions', description : 'Permissions of the API key pair.', type : 'list'}, {}, {name : 'domainid', description : 'ID of the domain which the account belongs to.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'ID of the API key pair.', type : 'string'}, {name : 'startdate', description : 'API key pair start date.', type : 'date'}, {name : 'enddate', description : 'API key pair expiration date.', type : 'date'}, {name : 'accounttype', description : 'Account type.', type : 'string'}, {name : 'username', description : "Username of the keypair's owner.", type : 'string'}, {name : 'created', description : 'API key pair creation timestamp.', type : 'date'}], httprequesttype : 'GET'}, {name : 'startKubernetesCluster', description : 'Starts a stopped CloudManaged Kubernetes cluster', isasync : True, related : '', params : [{name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'startKubernetesCluster'}], response : [{name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'name', description : 'The name of the Kubernetes cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'listSharedFileSystemProviders', description : 'Lists all available shared filesystem providers.', since : '4.20.0', isasync : False, related : '', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'name', description : 'the name of the shared filesystem provider', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'listBackupSchedule', description : 'List backup schedule of an Instance', since : '4.14.0', isasync : False, related : '', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'the ID of the backup schedule', type : 'uuid', length : 255, required : False, since : '4.22.0', related : 'listBackupSchedule'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'listall', description : "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'isrecursive', description : 'Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.', type : 'boolean', length : 255, required : False}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'uuid', length : 255, required : False, related : 'scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,importVm'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}], response : [{name : 'id', description : 'ID of the backup schedule.', type : 'string'}, {name : 'intervaltype', description : 'The interval type of the backup schedule', type : 'intervaltype'}, {}, {}, {name : 'quiescevm', description : 'quiesce the instance before checkpointing the disks for backup', type : 'boolean'}, {name : 'timezone', description : 'The time zone of the backup schedule', type : 'string'}, {name : 'maxbackups', description : 'maximum number of backups retained', type : 'integer'}, {name : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'schedule', description : 'The time the backup is scheduled to be taken.', type : 'string'}, {name : 'isolated', description : 'Whether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'GET'}, {name : 'restoreVolumeFromBackupAndAttachToVM', description : 'Restore and attach a backed up volume to Instance', since : '4.14.0', isasync : True, params : [{name : 'hostid', description : 'If quickrestore is true, which host to start the VM on; otherwise, ignored. Currently this parameter is only supported by the KBOSS provider.', type : 'uuid', length : 255, required : False, since : '4.23.0', related : ''}, {name : 'quickrestore', description : 'Whether to use the quick restore process or not. Currently this parameter is only supported by the KBOSS provider.', type : 'boolean', length : 255, required : False, since : '4.23.0'}, {name : 'backupid', description : 'ID of the Instance backup', type : 'uuid', length : 255, required : True, related : ''}, {name : 'volumeid', description : 'ID of the volume backed up', type : 'string', length : 255, required : True}, {name : 'virtualmachineid', description : 'ID of the Instance where to attach the restored volume', type : 'uuid', length : 255, required : True, related : 'scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,importVm'}], response : [{}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'removeNetworkPermissions', description : 'Removes Network permissions.', since : '4.17.0', isasync : False, params : [{name : 'networkid', description : 'The Network ID', type : 'uuid', length : 255, required : True, related : 'createNetwork,updateNetwork,listNetworks'}, {name : 'accountids', description : 'A comma delimited list of account IDs within owner\'s domain. If specified, "op" parameter has to be passed in.', type : 'list', length : 255, required : False, related : 'listAccounts'}, {name : 'projectids', description : 'A comma delimited list of projects within owner\'s domain. If specified, "op" parameter has to be passed in.', type : 'list', length : 255, required : False, related : ''}, {name : 'accounts', description : 'A comma delimited list of Accounts within owner\'s domain. If specified, "op" parameter has to be passed in.', type : 'list', length : 255, required : False}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteBackup', description : 'Delete Instance backup', since : '4.14.0', isasync : True, params : [{name : 'id', description : 'ID of the Instance backup', type : 'uuid', length : 255, required : True, related : ''}, {name : 'forced', description : 'Force the deletion of backup which removes the entire backup chain but keep Instance in Backup Offering', type : 'boolean', length : 255, required : False, since : '4.18.0.0'}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'deleteProjectRolePermission', description : 'Deletes a project role permission in the project', since : '4.15.0', isasync : False, params : [{name : 'projectid', description : 'ID of the project where the project role permission is to be deleted', type : 'uuid', length : 255, required : True, related : ''}, {name : 'id', description : 'ID of the project role permission to be deleted', type : 'uuid', length : 255, required : True, related : ''}], response : [{name : 'success', description : 'True if operation is executed successfully', type : 'boolean'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], httprequesttype : 'POST'}, {name : 'updateVnfTemplate', description : 'Updates a template to VNF template or attributes of a VNF template.', since : '4.19.0', isasync : False, related : 'listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate', params : [{name : 'format', description : 'The format for the image', type : 'string', length : 255, required : False}, {name : 'requireshvm', description : 'True if the Template requires HVM, false otherwise; available only for updateTemplate API', type : 'boolean', length : 255, required : False}, {name : 'cleanupvnfnics', description : 'optional boolean field, which indicates if VNF nics will be cleaned up or not', type : 'boolean', length : 255, required : False}, {name : 'sshkeyenabled', description : 'True if the Template supports the SSHkey upload feature; default is false', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'The name of the image file', type : 'string', length : 251, required : False}, {name : 'id', description : 'The ID of the image file', type : 'uuid', length : 255, required : True, related : 'listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate'}, {name : 'isdynamicallyscalable', description : 'True if Template/ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean', length : 255, required : False}, {name : 'forcks', description : 'indicates that the template can be used for deployment of CKS clusters', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'forceupdateostype', description : 'Force OS type update. Warning: Updating OS type will update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.', type : 'boolean', length : 255, required : False, since : '4.21'}, {name : 'sortkey', description : 'Sort key of the Template, integer', type : 'integer', length : 255, required : False}, {name : 'vnfdetails', description : 'VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0', type : 'map', length : 255, required : False}, {name : 'bootable', description : 'True if image is bootable, false otherwise; available only for updateIso API', type : 'boolean', length : 255, required : False}, {name : 'cleanupdetails', description : 'Optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)', type : 'boolean', length : 255, required : False}, {name : 'templatetag', description : 'the tag for this template.', type : 'string', length : 255, required : False, since : '4.20.0'}, {name : 'cleanupvnfdetails', description : 'optional boolean field, which indicates if VNF details will be cleaned up or not', type : 'boolean', length : 255, required : False}, {name : 'ostypeid', description : 'The ID of the OS type that best represents the OS of this image.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'templatetype', description : 'The type of the Template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).', type : 'string', length : 255, required : False}, {name : 'displaytext', description : 'The display text of the image', type : 'string', length : 4096, required : False}, {name : 'isrouting', description : 'True if the Template type is routing i.e., if Template is used to deploy router', type : 'boolean', length : 255, required : False}, {name : 'arch', description : 'the CPU arch of the template/ISO. Valid options are: x86_64, aarch64, s390x', type : 'string', length : 255, required : False, since : '4.20'}, {name : 'details', description : 'Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61', type : 'map', length : 255, required : False}, {name : 'vnfnics', description : 'VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue.  Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC', type : 'map', length : 255, required : False}, {name : 'passwordenabled', description : 'True if the image supports the password reset feature; default is false', type : 'boolean', length : 255, required : False}], response : [{name : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {name : 'passwordenabled', description : 'True if the reset password feature is enabled, false otherwise', type : 'boolean'}, {name : 'extensionname', description : 'The name of extension linked to this template', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'isextractable', description : 'True if the Template is extractable, false otherwise', type : 'boolean'}, {name : 'format', description : 'The format of the Template.', type : 'imageformat'}, {name : 'userdataparams', description : 'List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata', type : 'string'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean'}, {}, {name : 'zonename', description : 'The name of the zone for this Template', type : 'string'}, {name : 'parenttemplateid', description : 'If Datadisk Template, then id of the root disk Template this Template belongs to', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'isready', description : 'True if the Template is ready to be deployed from, false otherwise.', type : 'boolean'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}, {name : 'sourcetemplateid', description : 'The Template ID of the parent Template if present', type : 'string'}, {name : 'url', description : 'The URL which the Template/ISO is registered from', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'requireshvm', description : 'True if Template requires HVM enabled, false otherwise', type : 'boolean'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'crossZones', description : 'True if the Template is managed across all Zones, false otherwise', type : 'boolean'}, {name : 'sshkeyenabled', description : 'True if Template is sshkey enabled, false otherwise', type : 'boolean'}, {name : 'arch', description : 'CPU Arch of the template', type : 'string'}, {name : 'account', description : 'The Account name to which the Template belongs', type : 'string'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {name : 'accountid', description : 'The Account id to which the Template belongs', type : 'string'}, {name : 'hostname', description : 'The name of the secondary storage host for the Template', type : 'string'}, {name : 'ostypeid', description : 'The ID of the OS type for this Template.', type : 'string'}, {name : 'size', description : 'The size of the Template', type : 'long'}, {name : 'userdataname', description : 'The name of userdata linked to this Template', type : 'string'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', type : 'string'}, {name : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'domain', description : 'The name of the domain to which the Template belongs', type : 'string'}, {name : 'deployasis', description : 'VMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.', type : 'boolean'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'hostid', description : 'The ID of the secondary storage host for the Template', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'status', description : 'The status of the Template', type : 'string'}, {name : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean'}, {name : 'checksum', description : 'Checksum of the Template', type : 'string'}, {name : 'name', description : 'The Template name', type : 'string'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {name : 'project', description : 'The project name of the Template', type : 'string'}, {name : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'userdataid', description : 'The id of userdata linked to this Template', type : 'string'}, {name : 'bits', description : 'The processor bit size', type : 'int'}, {name : 'extensionid', description : 'The ID of extension linked to this template', type : 'string'}, {name : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {name : 'displaytext', description : 'The Template display text', type : 'string'}, {name : 'ispublic', description : 'True if this Template is a public Template, false otherwise', type : 'boolean'}, {name : 'templatetype', description : 'The type of the Template', type : 'string'}, {}, {}, {name : 'directdownload', description : 'KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage', type : 'boolean'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}, {name : 'id', description : 'The Template ID', type : 'string'}, {name : 'domainid', description : 'The ID of the domain to which the Template belongs', type : 'string'}, {name : 'removed', description : 'The date this Template was removed', type : 'date'}, {name : 'templatetag', description : 'The tag of this Template', type : 'string'}], httprequesttype : 'POST'}, {name : 'listUserTwoFactorAuthenticatorProviders', description : 'Lists user two factor authenticator providers', since : '4.18.0', isasync : False, related : '', params : [{name : 'name', description : 'List user two factor authenticator provider by name', type : 'string', length : 255, required : False}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'The user two factor authenticator provider name', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'description', description : 'The description of the user two factor authenticator provider', type : 'string'}], httprequesttype : 'GET'}, {name : 'importVm', description : 'Import virtual machine from a unmanaged host into CloudStack', since : '4.19.0', isasync : True, related : 'scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances', params : [{name : 'diskpath', description : 'path of the disk image. It is the file name on file based storage pools (NFS, Local, SharedMountPoint), and the image name on RBD storage pools', type : 'string', length : 255, required : False}, {name : 'hostname', description : 'The host name of the Instance', type : 'string', length : 255, required : False}, {name : 'templateid', description : 'The ID of the Template for the Instance', type : 'uuid', length : 255, required : False, related : 'listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate'}, {name : 'clustername', description : '(only for importing VMs from VMware to KVM) Name of VMware cluster.', type : 'string', length : 255, required : False}, {name : 'hostid', description : 'Host where local disk is located', type : 'uuid', length : 255, required : False, related : ''}, {name : 'storageid', description : 'Shared storage pool where disk is located', type : 'uuid', length : 255, required : False, related : ''}, {name : 'host', description : 'the host name or IP address', type : 'string', length : 255, required : False}, {name : 'nicnetworklist', description : 'VM NIC to network id mapping using keys NIC and network', type : 'map', length : 255, required : False}, {name : 'importinstancehostid', description : '(only for importing VMs from VMware to KVM) optional - the host to import the converted instance from VMware to KVM.', type : 'uuid', length : 255, required : False, since : '4.19.2', related : ''}, {name : 'datadiskofferinglist', description : 'Datadisk Template to disk-offering mapping using keys disk and diskOffering', type : 'map', length : 255, required : False}, {name : 'domainid', description : 'Import Instance to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'osid', description : '(only for importing VMs from VMware to KVM) optional - the ID of the guest OS for the imported VM.', type : 'uuid', length : 255, required : False, since : '4.22.1', related : ''}, {name : 'hostip', description : '(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'datacentername', description : '(only for importing VMs from VMware to KVM) Name of VMware datacenter.', type : 'string', length : 255, required : False}, {name : 'hypervisor', description : 'hypervisor type of the host', type : 'string', length : 255, required : True}, {name : 'convertinstancepoolid', description : '(only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'forcemstoimportvmfiles', description : '(only for importing VMs from VMware to KVM) optional - if true, forces MS to export OVF from VMware to temporary storage, else uses KVM Host if ovftool is available, falls back to MS if not.', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'The name of the Instance as it is known to the hypervisor', type : 'string', length : 255, required : True}, {name : 'networkid', description : 'the network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,updateNetwork,listNetworks'}, {name : 'password', description : 'the password for the host', type : 'string', length : 255, required : False}, {name : 'convertinstancehostid', description : '(only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v conversion from VMware to KVM.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'username', description : 'the username for the host', type : 'string', length : 255, required : False}, {name : 'extraparams', description : '(only for importing VMs from VMware to KVM) optional - extra parameters to be passed on the virt-v2v command, if allowed by the administrator', type : 'string', length : 255, required : False, since : '4.22'}, {name : 'existingvcenterid', description : '(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter', type : 'uuid', length : 255, required : False, related : ''}, {name : 'projectid', description : 'Import Instance for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'nicipaddresslist', description : 'VM NIC to ip address mapping using keys NIC, ip4Address', type : 'map', length : 255, required : False}, {name : 'account', description : 'An optional account for the Instance. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'serviceofferingid', description : 'The service offering for the Instance', type : 'uuid', length : 255, required : True, related : 'updateServiceOffering'}, {name : 'importsource', description : 'Source location for Import', type : 'string', length : 255, required : True}, {name : 'usevddk', description : '(only for importing VMs from VMware to KVM) optional - if true, uses VDDK on the KVM conversion host for converting the VM. This parameter is mutually exclusive with forcemstoimportvmfiles.', type : 'boolean', length : 255, required : False, since : '4.22.1'}, {name : 'displayname', description : 'The display name of the Instance', type : 'string', length : 255, required : False}, {name : 'vcenter', description : '(only for importing VMs from VMware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.', type : 'string', length : 255, required : False}, {name : 'forced', description : "Instance is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", type : 'boolean', length : 255, required : False}, {name : 'temppath', description : 'Temp Path on external host for disk image copy', type : 'string', length : 255, required : False}, {name : 'migrateallowed', description : 'Instance and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool', type : 'boolean', length : 255, required : False}, {name : 'forceconverttopool', description : '(only for importing VMs from VMware to KVM) optional - if true, forces virt-v2v conversions to write directly on the provided storage pool (avoid using temporary conversion pool).', type : 'boolean', length : 255, required : False, since : '4.22'}, {name : 'clusterid', description : 'The cluster ID', type : 'uuid', length : 255, required : True, related : ''}, {name : 'details', description : 'Used to specify the custom parameters.', type : 'map', length : 255, required : False}], response : [{name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'alloweddetails', description : 'List of allowed Vm details as comma separated string if VM instance settings are read from OVA.', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'isomaxcount', description : "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", type : 'integer'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'isos', description : 'All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.', type : 'list', response : [{name : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'deviceseq', description : 'The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)', type : 'integer'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}]}, {}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}]}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}]}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}]}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {}, {}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'diskofferingid', description : 'The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}]}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}]}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'project', description : 'The project name of the group', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', type : 'string'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'account', description : 'Account owning the security group rule', type : 'string'}, {name : 'cidr', description : 'The CIDR notation for the base IP address of the security group rule', type : 'string'}, {name : 'icmpcode', description : 'The code for the ICMP message response', type : 'integer'}, {name : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}]}]}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}]}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'templateid', description : 'The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.', type : 'string'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'diskofferingname', description : 'The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}], httprequesttype : 'POST'}]
2026-10-09 17:14:20,326 - DEBUG - Payload: {'command': 'listAccounts', 'response': 'json', 'apiKey': 'nffSzKgy7YUikAIJ3wkVODRposyx15FHLgJHmM8WCO3eMIDE-X9kkcQWkoQ9smtXEzrF1MyhjKYJ-kaL6DRmSQ', 'signature': b'/8LLgEpQzU/XlZo+wO45Ue96c58='}
2026-10-09 17:14:20,326 - DEBUG - ========Sending GET Cmd : listAccounts=======
2026-10-09 17:14:20,391 - DEBUG - Response : [{id : '1b6669e6-3534-482f-acbd-79c0f97f629c', name : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', accounttype : 0, roleid : 'aff02351-4f31-469d-9536-5ee719f01da8', roletype : 'User', rolename : 'MarvinFake Role o05v0k3wo4', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:12+0000', user : [{id : 'c8160519-f991-46c9-b98a-d71845263e59', username : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:12+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG', accounttype : 0, usersource : 'native', roleid : 'aff02351-4f31-469d-9536-5ee719f01da8', roletype : 'User', rolename : 'MarvinFake Role o05v0k3wo4', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', apikey : 'nffSzKgy7YUikAIJ3wkVODRposyx15FHLgJHmM8WCO3eMIDE-X9kkcQWkoQ9smtXEzrF1MyhjKYJ-kaL6DRmSQ', accountid : '1b6669e6-3534-482f-acbd-79c0f97f629c', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : []}]
2026-10-09 17:14:20,391 - DEBUG - Payload: {'command': 'listHosts', 'response': 'json', 'apiKey': 'nffSzKgy7YUikAIJ3wkVODRposyx15FHLgJHmM8WCO3eMIDE-X9kkcQWkoQ9smtXEzrF1MyhjKYJ-kaL6DRmSQ', 'signature': b'8z5zZ74beeyE2N7HMgC0lXIm9rU='}
2026-10-09 17:14:20,391 - DEBUG - ========Sending GET Cmd : listHosts=======
2026-10-09 17:14:20,405 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listHosts] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG.\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listHosts] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG.
2026-10-09 17:14:20,405 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.listHosts.listHostsCmd object at 0x7f2246ec9130> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listHosts] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG.\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listHosts] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG.
2026-10-09 17:14:20,405 - DEBUG - Payload: {'command': 'listZones', 'response': 'json', 'apiKey': 'nffSzKgy7YUikAIJ3wkVODRposyx15FHLgJHmM8WCO3eMIDE-X9kkcQWkoQ9smtXEzrF1MyhjKYJ-kaL6DRmSQ', 'signature': b'AB7qPXkkpriOjkawEoDa/p9r9FQ='}
2026-10-09 17:14:20,406 - DEBUG - ========Sending GET Cmd : listZones=======
2026-10-09 17:14:20,418 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listZones] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG.\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listZones] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG.
2026-10-09 17:14:20,418 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.listZones.listZonesCmd object at 0x7f2246ec9700> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listZones] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG.\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: error failed, due to: errorCode: 432, errorText:The API [listZones] does not exist or is not available for the account rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-LX20DG.
2026-10-09 17:14:20,419 - DEBUG - Payload: {'id': '1b6669e6-3534-482f-acbd-79c0f97f629c', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'yQyas0ZcZyuD8mQ3ULJKl+IhQqQ='}
2026-10-09 17:14:20,419 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:20,469 - DEBUG - === Jobid: 59266c3e-6cdf-4f4e-ad07-5429f5a7265f Started ===
2026-10-09 17:14:20,470 - DEBUG - Payload: {'jobid': '59266c3e-6cdf-4f4e-ad07-5429f5a7265f', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'LfYI8GyBRmb4omX5VoYj0uHj70Y='}
2026-10-09 17:14:20,470 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:20,518 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '1b6669e6-3534-482f-acbd-79c0f97f629c', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:20+0000', jobid : '59266c3e-6cdf-4f4e-ad07-5429f5a7265f', jobstatus : 0}
2026-10-09 17:14:21,519 - DEBUG - === JobId:59266c3e-6cdf-4f4e-ad07-5429f5a7265f is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:21,520 - DEBUG - Payload: {'jobid': '59266c3e-6cdf-4f4e-ad07-5429f5a7265f', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'LfYI8GyBRmb4omX5VoYj0uHj70Y='}
2026-10-09 17:14:21,520 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:21,549 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '1b6669e6-3534-482f-acbd-79c0f97f629c', created : '2026-10-09T17:14:20+0000', completed : '2026-10-09T17:14:20+0000', jobid : '59266c3e-6cdf-4f4e-ad07-5429f5a7265f', jobstatus : 1}
2026-10-09 17:14:21,549 - DEBUG - ===Jobid:59266c3e-6cdf-4f4e-ad07-5429f5a7265f ; StartTime:Fri Oct  9 17:14:20 2026 ; EndTime:Fri Oct  9 17:14:21 2026 ; TotalTime:-1===
2026-10-09 17:14:21,549 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '1b6669e6-3534-482f-acbd-79c0f97f629c', created : '2026-10-09T17:14:20+0000', completed : '2026-10-09T17:14:20+0000', jobid : '59266c3e-6cdf-4f4e-ad07-5429f5a7265f', jobstatus : 1}
2026-10-09 17:14:21,549 - DEBUG - Payload: {'id': '3e875418-8ade-4997-abe8-011d9dd22e5a', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'SoioVPwV6jdzIkDz4iAuUZVvtuQ='}
2026-10-09 17:14:21,549 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:21,590 - DEBUG - Response : {success : True}
2026-10-09 17:14:21,590 - DEBUG - Payload: {'id': 'aff02351-4f31-469d-9536-5ee719f01da8', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mbDEypdWnq+7CbeM5RTHDdNMhys='}
2026-10-09 17:14:21,591 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:21,632 - DEBUG - Response : {success : True}
2026-10-09 17:14:21,633 - DEBUG - TestCaseName: test_role_account_acls_multiple_mgmt_servers; Time Taken: 10 Seconds; StartTime: Fri Oct  9 17:14:11 2026; EndTime: Fri Oct  9 17:14:21 2026; Result: SUCCESS
2026-10-09 17:14:21,634 - DEBUG - ::::::::::::STARTED : TC: test_role_inuse_deletion :::::::::::
2026-10-09 17:14:21,634 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:21,634 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:21,673 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:21,674 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role e1oqzh2goo', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Jg8yONQx2Z7nNf37JRv9TlraQ+4='}
2026-10-09 17:14:21,674 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:21,708 - DEBUG - Response : {type : 'User', state : 'enabled', id : '290f2bc7-5735-45a9-8bf4-63298da33dbc', name : 'MarvinFake Role e1oqzh2goo', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:21,708 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '290f2bc7-5735-45a9-8bf4-63298da33dbc', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'1pzHdmTc4xEz4zD9XMOb6yn6bYY='}
2026-10-09 17:14:21,708 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:21,742 - DEBUG - Response : {id : 'f0f95bbb-42cc-4f67-b3f2-e5b46dc3a4e1', roleid : '290f2bc7-5735-45a9-8bf4-63298da33dbc', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:21,743 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '290f2bc7-5735-45a9-8bf4-63298da33dbc', 'username': 'rolete-TestDynamicRoles-test_role_inuse_deletion-5I8IFM', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'H65NoC6MSbhgJUepFhzjt9Ke3xw='}
2026-10-09 17:14:21,743 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:14:23,060 - DEBUG - Response : {id : '695cba4a-aafe-4c56-87b8-7e8932ab24d6', name : 'rolete-TestDynamicRoles-test_role_inuse_deletion-5I8IFM', accounttype : 0, roleid : '290f2bc7-5735-45a9-8bf4-63298da33dbc', roletype : 'User', rolename : 'MarvinFake Role e1oqzh2goo', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:22+0000', user : [{id : 'eeebc850-7f60-4aeb-9617-f8e27438d40f', username : 'rolete-TestDynamicRoles-test_role_inuse_deletion-5I8IFM', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:22+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_inuse_deletion-5I8IFM', accounttype : 0, usersource : 'native', roleid : '290f2bc7-5735-45a9-8bf4-63298da33dbc', roletype : 'User', rolename : 'MarvinFake Role e1oqzh2goo', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '695cba4a-aafe-4c56-87b8-7e8932ab24d6', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:14:23,061 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:14:23,061 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:14:23,095 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:14:23,096 - DEBUG - Payload: {'id': '290f2bc7-5735-45a9-8bf4-63298da33dbc', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'xmdZxnhObNe6JghlacRYT7y2CiE='}
2026-10-09 17:14:23,096 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:23,125 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', "marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Found accounts that have role in use, won't allow to delete role\n"]
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Found accounts that have role in use, won't allow to delete role
2026-10-09 17:14:23,125 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRole.deleteRoleCmd object at 0x7f2246ec9670> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', "marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Found accounts that have role in use, won't allow to delete role\n"]
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterole failed, due to: errorCode: 531, errorText:Found accounts that have role in use, won't allow to delete role
2026-10-09 17:14:23,126 - DEBUG - Payload: {'id': '695cba4a-aafe-4c56-87b8-7e8932ab24d6', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'D3uHCakQD+2O+XWdurGVQjuzrSA='}
2026-10-09 17:14:23,126 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:23,175 - DEBUG - === Jobid: a17ee188-bd02-47ac-956c-08b76149f92e Started ===
2026-10-09 17:14:23,176 - DEBUG - Payload: {'jobid': 'a17ee188-bd02-47ac-956c-08b76149f92e', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'RBHr1DXFxCFUIl5GHaCN2mjbhcg='}
2026-10-09 17:14:23,176 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:23,218 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '695cba4a-aafe-4c56-87b8-7e8932ab24d6', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:23+0000', jobid : 'a17ee188-bd02-47ac-956c-08b76149f92e', jobstatus : 0}
2026-10-09 17:14:24,219 - DEBUG - === JobId:a17ee188-bd02-47ac-956c-08b76149f92e is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:24,220 - DEBUG - Payload: {'jobid': 'a17ee188-bd02-47ac-956c-08b76149f92e', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'RBHr1DXFxCFUIl5GHaCN2mjbhcg='}
2026-10-09 17:14:24,220 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:24,262 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '695cba4a-aafe-4c56-87b8-7e8932ab24d6', created : '2026-10-09T17:14:23+0000', completed : '2026-10-09T17:14:23+0000', jobid : 'a17ee188-bd02-47ac-956c-08b76149f92e', jobstatus : 1}
2026-10-09 17:14:24,262 - DEBUG - ===Jobid:a17ee188-bd02-47ac-956c-08b76149f92e ; StartTime:Fri Oct  9 17:14:23 2026 ; EndTime:Fri Oct  9 17:14:24 2026 ; TotalTime:-1===
2026-10-09 17:14:24,262 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '695cba4a-aafe-4c56-87b8-7e8932ab24d6', created : '2026-10-09T17:14:23+0000', completed : '2026-10-09T17:14:23+0000', jobid : 'a17ee188-bd02-47ac-956c-08b76149f92e', jobstatus : 1}
2026-10-09 17:14:24,263 - DEBUG - Payload: {'id': 'f0f95bbb-42cc-4f67-b3f2-e5b46dc3a4e1', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'IZ8WLWSYG90mEO09dxVy4EAKkUQ='}
2026-10-09 17:14:24,263 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:24,299 - DEBUG - Response : {success : True}
2026-10-09 17:14:24,300 - DEBUG - Payload: {'id': '290f2bc7-5735-45a9-8bf4-63298da33dbc', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'xmdZxnhObNe6JghlacRYT7y2CiE='}
2026-10-09 17:14:24,300 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:24,346 - DEBUG - Response : {success : True}
2026-10-09 17:14:24,346 - DEBUG - TestCaseName: test_role_inuse_deletion; Time Taken: 2 Seconds; StartTime: Fri Oct  9 17:14:21 2026; EndTime: Fri Oct  9 17:14:24 2026; Result: SUCCESS
2026-10-09 17:14:24,346 - DEBUG - ::::::::::::STARTED : TC: test_role_lifecycle_clone :::::::::::
2026-10-09 17:14:24,347 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:24,347 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:24,402 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:24,403 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role egeap1j0gr', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'km1wdAL+AQt/IA4s37OuoFPwiZA='}
2026-10-09 17:14:24,403 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:24,450 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'b4bef487-2f0e-4b25-a0bf-d50aeabf1bcf', name : 'MarvinFake Role egeap1j0gr', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:24,451 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'b4bef487-2f0e-4b25-a0bf-d50aeabf1bcf', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'j1LDFg7e/6oHGp/xuVPv+Kzt/Ss='}
2026-10-09 17:14:24,451 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:24,489 - DEBUG - Response : {id : '12ab3fec-44c8-426c-a056-40f01304a606', roleid : 'b4bef487-2f0e-4b25-a0bf-d50aeabf1bcf', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:24,489 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': 'b4bef487-2f0e-4b25-a0bf-d50aeabf1bcf', 'username': 'rolete-TestDynamicRoles-test_role_lifecycle_clone-SNJAHR', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'2DqyoF8yx+T7+Ab221gVUIRtaK8='}
2026-10-09 17:14:24,489 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:14:25,860 - DEBUG - Response : {id : '043a67d0-732b-46e2-b497-4ace6607c38c', name : 'rolete-TestDynamicRoles-test_role_lifecycle_clone-SNJAHR', accounttype : 0, roleid : 'b4bef487-2f0e-4b25-a0bf-d50aeabf1bcf', roletype : 'User', rolename : 'MarvinFake Role egeap1j0gr', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:25+0000', user : [{id : 'd0ee5464-93c5-41ba-b59e-79ac72a3066e', username : 'rolete-TestDynamicRoles-test_role_lifecycle_clone-SNJAHR', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:25+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_lifecycle_clone-SNJAHR', accounttype : 0, usersource : 'native', roleid : 'b4bef487-2f0e-4b25-a0bf-d50aeabf1bcf', roletype : 'User', rolename : 'MarvinFake Role egeap1j0gr', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '043a67d0-732b-46e2-b497-4ace6607c38c', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:14:25,860 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:14:25,860 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:14:25,890 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:14:25,890 - DEBUG - Payload: {'description': 'Fake Role cloned by Marvin test', 'name': 'MarvinFake Clone Role ', 'roleid': 'b4bef487-2f0e-4b25-a0bf-d50aeabf1bcf', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Cwez+ZDXsIQoZgmU39i7tl5qhe4='}
2026-10-09 17:14:25,890 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:25,938 - DEBUG - Response : {type : 'User', state : 'enabled', id : '099bafac-88e9-4976-a844-db19bd07e0a2', name : 'MarvinFake Clone Role ', description : 'Fake Role cloned by Marvin test', ispublic : True}
2026-10-09 17:14:25,939 - DEBUG - Payload: {'id': '099bafac-88e9-4976-a844-db19bd07e0a2', 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'5ZfqO7N/8U+7Q/S5cxdOTb71RXs='}
2026-10-09 17:14:25,939 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-09 17:14:25,968 - DEBUG - Response : [{type : 'User', isdefault : False, state : 'enabled', id : '099bafac-88e9-4976-a844-db19bd07e0a2', name : 'MarvinFake Clone Role ', description : 'Fake Role cloned by Marvin test', ispublic : True}]
2026-10-09 17:14:25,968 - DEBUG - Payload: {'roleid': 'b4bef487-2f0e-4b25-a0bf-d50aeabf1bcf', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'USkvGWWaYJ/4Nlf8HJllwyntfEo='}
2026-10-09 17:14:25,968 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:14:25,989 - DEBUG - Response : [{id : '12ab3fec-44c8-426c-a056-40f01304a606', roleid : 'b4bef487-2f0e-4b25-a0bf-d50aeabf1bcf', rolename : 'MarvinFake Role egeap1j0gr', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-09 17:14:25,990 - DEBUG - Payload: {'roleid': '099bafac-88e9-4976-a844-db19bd07e0a2', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'uSWH/MeeuiiXw4svnYEOLvBD9Xw='}
2026-10-09 17:14:25,990 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:14:26,015 - DEBUG - Response : [{id : '2e1e5114-d2fd-4a28-8a3d-6210ec5d0c94', roleid : '099bafac-88e9-4976-a844-db19bd07e0a2', rolename : 'MarvinFake Clone Role ', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-09 17:14:26,016 - DEBUG - Payload: {'id': '043a67d0-732b-46e2-b497-4ace6607c38c', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'3pwWIPdeYPqxWStEe6DeqhJyUQQ='}
2026-10-09 17:14:26,016 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:26,066 - DEBUG - === Jobid: 28388a61-6410-4dd0-8dc8-ef4c41445763 Started ===
2026-10-09 17:14:26,066 - DEBUG - Payload: {'jobid': '28388a61-6410-4dd0-8dc8-ef4c41445763', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'SuWSqmRJ6aV6ri6asmIAbrmLhNs='}
2026-10-09 17:14:26,066 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:26,105 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '043a67d0-732b-46e2-b497-4ace6607c38c', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:26+0000', jobid : '28388a61-6410-4dd0-8dc8-ef4c41445763', jobstatus : 0}
2026-10-09 17:14:27,107 - DEBUG - === JobId:28388a61-6410-4dd0-8dc8-ef4c41445763 is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:27,108 - DEBUG - Payload: {'jobid': '28388a61-6410-4dd0-8dc8-ef4c41445763', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'SuWSqmRJ6aV6ri6asmIAbrmLhNs='}
2026-10-09 17:14:27,108 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:27,143 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '043a67d0-732b-46e2-b497-4ace6607c38c', created : '2026-10-09T17:14:26+0000', completed : '2026-10-09T17:14:26+0000', jobid : '28388a61-6410-4dd0-8dc8-ef4c41445763', jobstatus : 1}
2026-10-09 17:14:27,144 - DEBUG - ===Jobid:28388a61-6410-4dd0-8dc8-ef4c41445763 ; StartTime:Fri Oct  9 17:14:26 2026 ; EndTime:Fri Oct  9 17:14:27 2026 ; TotalTime:-1===
2026-10-09 17:14:27,144 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '043a67d0-732b-46e2-b497-4ace6607c38c', created : '2026-10-09T17:14:26+0000', completed : '2026-10-09T17:14:26+0000', jobid : '28388a61-6410-4dd0-8dc8-ef4c41445763', jobstatus : 1}
2026-10-09 17:14:27,144 - DEBUG - Payload: {'id': '12ab3fec-44c8-426c-a056-40f01304a606', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'1gvUp3wOodxGZ4J1xOsGLW8MvUY='}
2026-10-09 17:14:27,144 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:27,183 - DEBUG - Response : {success : True}
2026-10-09 17:14:27,184 - DEBUG - Payload: {'id': 'b4bef487-2f0e-4b25-a0bf-d50aeabf1bcf', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'QPQv4I1wWx/sCWYs8y+8zv55Vr0='}
2026-10-09 17:14:27,184 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:27,271 - DEBUG - Response : {success : True}
2026-10-09 17:14:27,272 - DEBUG - Payload: {'id': '099bafac-88e9-4976-a844-db19bd07e0a2', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Qfkvx0/ztLBgBOTuvTpk+otl1jc='}
2026-10-09 17:14:27,272 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:27,315 - DEBUG - Response : {success : True}
2026-10-09 17:14:27,316 - DEBUG - TestCaseName: test_role_lifecycle_clone; Time Taken: 2 Seconds; StartTime: Fri Oct  9 17:14:24 2026; EndTime: Fri Oct  9 17:14:27 2026; Result: SUCCESS
2026-10-09 17:14:27,316 - DEBUG - ::::::::::::STARTED : TC: test_role_lifecycle_create :::::::::::
2026-10-09 17:14:27,316 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:27,316 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:27,359 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:27,359 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role o15uao4ev9', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'KwmvCNuj9++fodRshVqO34v4sUI='}
2026-10-09 17:14:27,359 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:27,406 - DEBUG - Response : {type : 'User', state : 'enabled', id : '0bac851c-957d-4d21-86ec-47808e604bc2', name : 'MarvinFake Role o15uao4ev9', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:27,407 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '0bac851c-957d-4d21-86ec-47808e604bc2', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'MRtJfWqBVvvjwcPDjrf7YTKbP3k='}
2026-10-09 17:14:27,407 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:27,452 - DEBUG - Response : {id : '27af100f-c9c4-4c15-b0f8-28fb0ad61467', roleid : '0bac851c-957d-4d21-86ec-47808e604bc2', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:27,453 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '0bac851c-957d-4d21-86ec-47808e604bc2', 'username': 'rolete-TestDynamicRoles-test_role_lifecycle_create-MEJ2Q0', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'NxvMX30WXsRnYVPYaYCtYFLUCiA='}
2026-10-09 17:14:27,453 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:14:28,898 - DEBUG - Response : {id : '63ea443a-64d5-4f4a-b610-e25abfe8b120', name : 'rolete-TestDynamicRoles-test_role_lifecycle_create-MEJ2Q0', accounttype : 0, roleid : '0bac851c-957d-4d21-86ec-47808e604bc2', roletype : 'User', rolename : 'MarvinFake Role o15uao4ev9', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:28+0000', user : [{id : '4e2b62cf-26ed-42e1-b07b-ea10e29469d0', username : 'rolete-TestDynamicRoles-test_role_lifecycle_create-MEJ2Q0', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:28+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_lifecycle_create-MEJ2Q0', accounttype : 0, usersource : 'native', roleid : '0bac851c-957d-4d21-86ec-47808e604bc2', roletype : 'User', rolename : 'MarvinFake Role o15uao4ev9', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '63ea443a-64d5-4f4a-b610-e25abfe8b120', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:14:28,898 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:14:28,899 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:14:28,925 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:14:28,926 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role o15uao4ev9', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'KwmvCNuj9++fodRshVqO34v4sUI='}
2026-10-09 17:14:28,926 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:28,967 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: createrole failed, due to: errorCode: 530, errorText:Entity already exists \n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: createrole failed, due to: errorCode: 530, errorText:Entity already exists 
2026-10-09 17:14:28,967 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.createRole.createRoleCmd object at 0x7f2246ec9460> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: createrole failed, due to: errorCode: 530, errorText:Entity already exists \n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: createrole failed, due to: errorCode: 530, errorText:Entity already exists 
2026-10-09 17:14:28,968 - DEBUG - Payload: {'id': '0bac851c-957d-4d21-86ec-47808e604bc2', 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'yfUXHxWoLMJoISBw/fm0WGiJvgk='}
2026-10-09 17:14:28,968 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-09 17:14:28,992 - DEBUG - Response : [{type : 'User', isdefault : False, state : 'enabled', id : '0bac851c-957d-4d21-86ec-47808e604bc2', name : 'MarvinFake Role o15uao4ev9', description : 'Fake Role created by Marvin test', ispublic : True}]
2026-10-09 17:14:28,993 - DEBUG - Payload: {'id': '63ea443a-64d5-4f4a-b610-e25abfe8b120', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'rbNB+84j1ndAAxu4xnhxl7NvSmg='}
2026-10-09 17:14:28,993 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:29,035 - DEBUG - === Jobid: 5978c06d-0592-4285-a4b8-06c65971dd86 Started ===
2026-10-09 17:14:29,036 - DEBUG - Payload: {'jobid': '5978c06d-0592-4285-a4b8-06c65971dd86', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'HiK0VzGATORAKqrADyrlqK5NOnI='}
2026-10-09 17:14:29,036 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:29,083 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '63ea443a-64d5-4f4a-b610-e25abfe8b120', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:29+0000', jobid : '5978c06d-0592-4285-a4b8-06c65971dd86', jobstatus : 0}
2026-10-09 17:14:30,085 - DEBUG - === JobId:5978c06d-0592-4285-a4b8-06c65971dd86 is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:30,085 - DEBUG - Payload: {'jobid': '5978c06d-0592-4285-a4b8-06c65971dd86', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'HiK0VzGATORAKqrADyrlqK5NOnI='}
2026-10-09 17:14:30,085 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:30,123 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '63ea443a-64d5-4f4a-b610-e25abfe8b120', created : '2026-10-09T17:14:29+0000', completed : '2026-10-09T17:14:29+0000', jobid : '5978c06d-0592-4285-a4b8-06c65971dd86', jobstatus : 1}
2026-10-09 17:14:30,123 - DEBUG - ===Jobid:5978c06d-0592-4285-a4b8-06c65971dd86 ; StartTime:Fri Oct  9 17:14:29 2026 ; EndTime:Fri Oct  9 17:14:30 2026 ; TotalTime:-1===
2026-10-09 17:14:30,123 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '63ea443a-64d5-4f4a-b610-e25abfe8b120', created : '2026-10-09T17:14:29+0000', completed : '2026-10-09T17:14:29+0000', jobid : '5978c06d-0592-4285-a4b8-06c65971dd86', jobstatus : 1}
2026-10-09 17:14:30,123 - DEBUG - Payload: {'id': '27af100f-c9c4-4c15-b0f8-28fb0ad61467', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'N8EOHt25I0m9NGFID5NP8Ptu8b8='}
2026-10-09 17:14:30,124 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:30,175 - DEBUG - Response : {success : True}
2026-10-09 17:14:30,176 - DEBUG - Payload: {'id': '0bac851c-957d-4d21-86ec-47808e604bc2', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'qnad0FiL8Goxg9On3pgx0OBr1Tg='}
2026-10-09 17:14:30,176 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:30,221 - DEBUG - Response : {success : True}
2026-10-09 17:14:30,221 - DEBUG - TestCaseName: test_role_lifecycle_create; Time Taken: 2 Seconds; StartTime: Fri Oct  9 17:14:27 2026; EndTime: Fri Oct  9 17:14:30 2026; Result: SUCCESS
2026-10-09 17:14:30,221 - DEBUG - ::::::::::::STARTED : TC: test_role_lifecycle_delete :::::::::::
2026-10-09 17:14:30,222 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:30,222 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:30,276 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:30,277 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role n2j1amw5zn', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'dhHn5k4S5CEDxU1KwcCvq9hj8HI='}
2026-10-09 17:14:30,277 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:30,313 - DEBUG - Response : {type : 'User', state : 'enabled', id : '1a02b871-b81d-447c-ae1f-1ba8553b1375', name : 'MarvinFake Role n2j1amw5zn', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:30,313 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '1a02b871-b81d-447c-ae1f-1ba8553b1375', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'4JQDf/ZX9Q1adjzjHAhMgntOqtM='}
2026-10-09 17:14:30,313 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:30,352 - DEBUG - Response : {id : '518bde5c-32c8-48ac-ad42-0e432c66202f', roleid : '1a02b871-b81d-447c-ae1f-1ba8553b1375', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:30,352 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '1a02b871-b81d-447c-ae1f-1ba8553b1375', 'username': 'rolete-TestDynamicRoles-test_role_lifecycle_delete-Q0KXRY', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'QP/yDOX4EQ8mThZfJ34xQLnt9LY='}
2026-10-09 17:14:30,352 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:14:31,674 - DEBUG - Response : {id : '3b76efc2-f732-4554-b245-548c3bd836fa', name : 'rolete-TestDynamicRoles-test_role_lifecycle_delete-Q0KXRY', accounttype : 0, roleid : '1a02b871-b81d-447c-ae1f-1ba8553b1375', roletype : 'User', rolename : 'MarvinFake Role n2j1amw5zn', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:31+0000', user : [{id : 'e00255b1-ad8b-4646-89c7-2b57776afc74', username : 'rolete-TestDynamicRoles-test_role_lifecycle_delete-Q0KXRY', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:31+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_lifecycle_delete-Q0KXRY', accounttype : 0, usersource : 'native', roleid : '1a02b871-b81d-447c-ae1f-1ba8553b1375', roletype : 'User', rolename : 'MarvinFake Role n2j1amw5zn', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '3b76efc2-f732-4554-b245-548c3bd836fa', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:14:31,675 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:14:31,675 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:14:31,697 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:14:31,698 - DEBUG - Payload: {'id': '3b76efc2-f732-4554-b245-548c3bd836fa', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'BUa+xe22SjXxC+A5Y7DF1JDez0A='}
2026-10-09 17:14:31,698 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:31,739 - DEBUG - === Jobid: 3c156eeb-2420-45b9-bde7-4410dabf6755 Started ===
2026-10-09 17:14:31,739 - DEBUG - Payload: {'jobid': '3c156eeb-2420-45b9-bde7-4410dabf6755', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'NLJTOi2Y8/ntVz+bO2KpAVlln00='}
2026-10-09 17:14:31,739 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:31,770 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '3b76efc2-f732-4554-b245-548c3bd836fa', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:31+0000', jobid : '3c156eeb-2420-45b9-bde7-4410dabf6755', jobstatus : 0}
2026-10-09 17:14:32,772 - DEBUG - === JobId:3c156eeb-2420-45b9-bde7-4410dabf6755 is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:32,772 - DEBUG - Payload: {'jobid': '3c156eeb-2420-45b9-bde7-4410dabf6755', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'NLJTOi2Y8/ntVz+bO2KpAVlln00='}
2026-10-09 17:14:32,772 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:32,809 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '3b76efc2-f732-4554-b245-548c3bd836fa', created : '2026-10-09T17:14:31+0000', completed : '2026-10-09T17:14:31+0000', jobid : '3c156eeb-2420-45b9-bde7-4410dabf6755', jobstatus : 1}
2026-10-09 17:14:32,809 - DEBUG - ===Jobid:3c156eeb-2420-45b9-bde7-4410dabf6755 ; StartTime:Fri Oct  9 17:14:31 2026 ; EndTime:Fri Oct  9 17:14:32 2026 ; TotalTime:-1===
2026-10-09 17:14:32,809 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '3b76efc2-f732-4554-b245-548c3bd836fa', created : '2026-10-09T17:14:31+0000', completed : '2026-10-09T17:14:31+0000', jobid : '3c156eeb-2420-45b9-bde7-4410dabf6755', jobstatus : 1}
2026-10-09 17:14:32,810 - DEBUG - Payload: {'id': '1a02b871-b81d-447c-ae1f-1ba8553b1375', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'1pp2lS7Wr8vK2y/sijGPKl2Tlmo='}
2026-10-09 17:14:32,810 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:32,847 - DEBUG - Response : {success : True}
2026-10-09 17:14:32,848 - DEBUG - Payload: {'id': '1a02b871-b81d-447c-ae1f-1ba8553b1375', 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'JAO4yR3Gk/Hry8W5RTJ+38qQdZY='}
2026-10-09 17:14:32,848 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-09 17:14:32,870 - DEBUG - Response : None
2026-10-09 17:14:32,871 - DEBUG - Payload: {'id': '3b76efc2-f732-4554-b245-548c3bd836fa', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'BUa+xe22SjXxC+A5Y7DF1JDez0A='}
2026-10-09 17:14:32,871 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:32,913 - DEBUG - === Jobid: 5012d13e-3ee7-412a-bdbb-34d0ea73ac18 Started ===
2026-10-09 17:14:32,913 - DEBUG - Payload: {'jobid': '5012d13e-3ee7-412a-bdbb-34d0ea73ac18', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'dnmZ2k+bgYdhhHYSfGSd52nEC4s='}
2026-10-09 17:14:32,913 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:32,960 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '3b76efc2-f732-4554-b245-548c3bd836fa', created : '2026-10-09T17:14:32+0000', completed : '2026-10-09T17:14:32+0000', jobid : '5012d13e-3ee7-412a-bdbb-34d0ea73ac18', jobstatus : 1}
2026-10-09 17:14:32,960 - DEBUG - ===Jobid:5012d13e-3ee7-412a-bdbb-34d0ea73ac18 ; StartTime:Fri Oct  9 17:14:32 2026 ; EndTime:Fri Oct  9 17:14:32 2026 ; TotalTime:0===
2026-10-09 17:14:32,960 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '3b76efc2-f732-4554-b245-548c3bd836fa', created : '2026-10-09T17:14:32+0000', completed : '2026-10-09T17:14:32+0000', jobid : '5012d13e-3ee7-412a-bdbb-34d0ea73ac18', jobstatus : 1}
2026-10-09 17:14:32,960 - DEBUG - Payload: {'id': '518bde5c-32c8-48ac-ad42-0e432c66202f', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'1upjdPz4+pQ3QOnk2IMqJiAJpjQ='}
2026-10-09 17:14:32,960 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:32,981 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterolepermission failed, due to: errorCode: 431, errorText:Unable to execute API command deleterolepermission due to invalid value. Invalid parameter id value=518bde5c-32c8-48ac-ad42-0e432c66202f due to incorrect long value format, or entity does not exist or due to incorrect parameter annotation for the field in api cmd class.\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterolepermission failed, due to: errorCode: 431, errorText:Unable to execute API command deleterolepermission due to invalid value. Invalid parameter id value=518bde5c-32c8-48ac-ad42-0e432c66202f due to incorrect long value format, or entity does not exist or due to incorrect parameter annotation for the field in api cmd class.
2026-10-09 17:14:32,981 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRolePermission.deleteRolePermissionCmd object at 0x7f2246ec9340> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterolepermission failed, due to: errorCode: 431, errorText:Unable to execute API command deleterolepermission due to invalid value. Invalid parameter id value=518bde5c-32c8-48ac-ad42-0e432c66202f due to incorrect long value format, or entity does not exist or due to incorrect parameter annotation for the field in api cmd class.\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterolepermission failed, due to: errorCode: 431, errorText:Unable to execute API command deleterolepermission due to invalid value. Invalid parameter id value=518bde5c-32c8-48ac-ad42-0e432c66202f due to incorrect long value format, or entity does not exist or due to incorrect parameter annotation for the field in api cmd class.
2026-10-09 17:14:32,981 - DEBUG - Warning! Exception in tearDown: Execute cmd: deleterolepermission failed, due to: errorCode: 431, errorText:Unable to execute API command deleterolepermission due to invalid value. Invalid parameter id value=518bde5c-32c8-48ac-ad42-0e432c66202f due to incorrect long value format, or entity does not exist or due to incorrect parameter annotation for the field in api cmd class.
2026-10-09 17:14:32,981 - DEBUG - TestCaseName: test_role_lifecycle_delete; Time Taken: 2 Seconds; StartTime: Fri Oct  9 17:14:30 2026; EndTime: Fri Oct  9 17:14:32 2026; Result: SUCCESS
2026-10-09 17:14:32,982 - DEBUG - ::::::::::::STARTED : TC: test_role_lifecycle_import :::::::::::
2026-10-09 17:14:32,982 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:32,982 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:33,025 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:33,026 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role 4d3apycp51', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ObUQIIgCBYgukqt0YZsxhN5PDzM='}
2026-10-09 17:14:33,026 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:33,067 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'b0e52a02-2ecf-4446-97d0-55861ca23a25', name : 'MarvinFake Role 4d3apycp51', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:33,067 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'b0e52a02-2ecf-4446-97d0-55861ca23a25', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Pb8ne44t/DdatbAub3QBtzo4RJA='}
2026-10-09 17:14:33,067 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:33,112 - DEBUG - Response : {id : 'dca92d6f-68c2-419a-90be-2f2b29cff694', roleid : 'b0e52a02-2ecf-4446-97d0-55861ca23a25', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:33,112 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': 'b0e52a02-2ecf-4446-97d0-55861ca23a25', 'username': 'rolete-TestDynamicRoles-test_role_lifecycle_import-EEBA4Y', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'/wb2D09NpuGarm0Q1Hu3UK+zC8o='}
2026-10-09 17:14:33,112 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:14:34,442 - DEBUG - Response : {id : '3a212a14-f81b-4dd0-b5c0-7a4b999b519a', name : 'rolete-TestDynamicRoles-test_role_lifecycle_import-EEBA4Y', accounttype : 0, roleid : 'b0e52a02-2ecf-4446-97d0-55861ca23a25', roletype : 'User', rolename : 'MarvinFake Role 4d3apycp51', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:34+0000', user : [{id : '70d99433-40d6-420e-ac4c-8f02b80013a0', username : 'rolete-TestDynamicRoles-test_role_lifecycle_import-EEBA4Y', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:34+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_lifecycle_import-EEBA4Y', accounttype : 0, usersource : 'native', roleid : 'b0e52a02-2ecf-4446-97d0-55861ca23a25', roletype : 'User', rolename : 'MarvinFake Role 4d3apycp51', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '3a212a14-f81b-4dd0-b5c0-7a4b999b519a', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:14:34,443 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:14:34,443 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:14:34,474 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:14:34,475 - DEBUG - Payload: {'description': 'Fake Import User Role created by Marvin test', 'name': 'MarvinFake Import Role xfbhuafai9', 'type': 'User', 'rules[0].rule': 'list*', 'rules[0].permission': 'allow', 'rules[0].description': 'Listing apis', 'rules[1].rule': 'get*', 'rules[1].permission': 'allow', 'rules[1].description': 'Get apis', 'rules[2].rule': 'update*', 'rules[2].permission': 'deny', 'rules[2].description': 'Update apis', 'command': 'importRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'H/mjdX+iygdIjPWWq7dq+nDEHeg='}
2026-10-09 17:14:34,475 - DEBUG - ========Sending GET Cmd : importRole=======
2026-10-09 17:14:34,536 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'eaa531a2-f71a-4540-98ca-514024917667', name : 'MarvinFake Import Role xfbhuafai9', description : 'Fake Import User Role created by Marvin test', ispublic : True}
2026-10-09 17:14:34,537 - DEBUG - Payload: {'id': 'eaa531a2-f71a-4540-98ca-514024917667', 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'YvrX93/knHPk+m1fA6LfXFJMNlI='}
2026-10-09 17:14:34,537 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-09 17:14:34,558 - DEBUG - Response : [{type : 'User', isdefault : False, state : 'enabled', id : 'eaa531a2-f71a-4540-98ca-514024917667', name : 'MarvinFake Import Role xfbhuafai9', description : 'Fake Import User Role created by Marvin test', ispublic : True}]
2026-10-09 17:14:34,559 - DEBUG - Payload: {'roleid': 'eaa531a2-f71a-4540-98ca-514024917667', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'HkDF1WQr+JAxQnE9l/Nd/uctQp4='}
2026-10-09 17:14:34,559 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:14:34,580 - DEBUG - Response : [{id : 'f7b4cb3b-26e6-4853-99c3-76b7e91c91a3', roleid : 'eaa531a2-f71a-4540-98ca-514024917667', rolename : 'MarvinFake Import Role xfbhuafai9', rule : 'list*', permission : 'allow', description : 'Listing apis'}, {id : 'f9772239-7bbe-4c5b-979b-d7bfa925f4ad', roleid : 'eaa531a2-f71a-4540-98ca-514024917667', rolename : 'MarvinFake Import Role xfbhuafai9', rule : 'get*', permission : 'allow', description : 'Get apis'}, {id : '64dec04a-2082-4dbf-a7d4-7068bab7d5c0', roleid : 'eaa531a2-f71a-4540-98ca-514024917667', rolename : 'MarvinFake Import Role xfbhuafai9', rule : 'update*', permission : 'deny', description : 'Update apis'}]
2026-10-09 17:14:34,581 - DEBUG - Payload: {'id': '3a212a14-f81b-4dd0-b5c0-7a4b999b519a', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'FDyu3qLKqu+lnVvjzQAQ6p0NVy8='}
2026-10-09 17:14:34,581 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:34,623 - DEBUG - === Jobid: e4a2d26b-0026-4c46-8aa6-d2f554f9497b Started ===
2026-10-09 17:14:34,623 - DEBUG - Payload: {'jobid': 'e4a2d26b-0026-4c46-8aa6-d2f554f9497b', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'P8z9oGHmAsZGLW41kUohR7+kQ1Q='}
2026-10-09 17:14:34,624 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:34,665 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '3a212a14-f81b-4dd0-b5c0-7a4b999b519a', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:34+0000', jobid : 'e4a2d26b-0026-4c46-8aa6-d2f554f9497b', jobstatus : 0}
2026-10-09 17:14:35,666 - DEBUG - === JobId:e4a2d26b-0026-4c46-8aa6-d2f554f9497b is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:35,666 - DEBUG - Payload: {'jobid': 'e4a2d26b-0026-4c46-8aa6-d2f554f9497b', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'P8z9oGHmAsZGLW41kUohR7+kQ1Q='}
2026-10-09 17:14:35,666 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:35,703 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '3a212a14-f81b-4dd0-b5c0-7a4b999b519a', created : '2026-10-09T17:14:34+0000', completed : '2026-10-09T17:14:34+0000', jobid : 'e4a2d26b-0026-4c46-8aa6-d2f554f9497b', jobstatus : 1}
2026-10-09 17:14:35,703 - DEBUG - ===Jobid:e4a2d26b-0026-4c46-8aa6-d2f554f9497b ; StartTime:Fri Oct  9 17:14:34 2026 ; EndTime:Fri Oct  9 17:14:35 2026 ; TotalTime:-1===
2026-10-09 17:14:35,703 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '3a212a14-f81b-4dd0-b5c0-7a4b999b519a', created : '2026-10-09T17:14:34+0000', completed : '2026-10-09T17:14:34+0000', jobid : 'e4a2d26b-0026-4c46-8aa6-d2f554f9497b', jobstatus : 1}
2026-10-09 17:14:35,704 - DEBUG - Payload: {'id': 'dca92d6f-68c2-419a-90be-2f2b29cff694', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'nWsV32dvlXDinvGIAxYCRlATPN8='}
2026-10-09 17:14:35,704 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:35,740 - DEBUG - Response : {success : True}
2026-10-09 17:14:35,740 - DEBUG - Payload: {'id': 'b0e52a02-2ecf-4446-97d0-55861ca23a25', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'kMU/0BCwAhPj9PpYoSWlju2K0rQ='}
2026-10-09 17:14:35,740 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:35,780 - DEBUG - Response : {success : True}
2026-10-09 17:14:35,780 - DEBUG - Payload: {'id': 'eaa531a2-f71a-4540-98ca-514024917667', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'S+Ar0HFgKsGJHu3qF/JPr0mYjGY='}
2026-10-09 17:14:35,780 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:35,827 - DEBUG - Response : {success : True}
2026-10-09 17:14:35,827 - DEBUG - TestCaseName: test_role_lifecycle_import; Time Taken: 2 Seconds; StartTime: Fri Oct  9 17:14:32 2026; EndTime: Fri Oct  9 17:14:35 2026; Result: SUCCESS
2026-10-09 17:14:35,827 - DEBUG - ::::::::::::STARTED : TC: test_role_lifecycle_list :::::::::::
2026-10-09 17:14:35,828 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:35,828 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:35,872 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:35,872 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role okuharubxx', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'zdsyKOKoirWB2ku/QiUAn4cIhE8='}
2026-10-09 17:14:35,872 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:35,912 - DEBUG - Response : {type : 'User', state : 'enabled', id : '2ad87b0f-bf02-47ae-ac34-3ec4ef9c419e', name : 'MarvinFake Role okuharubxx', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:35,912 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '2ad87b0f-bf02-47ae-ac34-3ec4ef9c419e', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'lrtIMO3rjM0DxzwDaSCGJEuGoZ0='}
2026-10-09 17:14:35,912 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:35,949 - DEBUG - Response : {id : 'a4d75155-dacd-4e18-97a8-29fc96d417cf', roleid : '2ad87b0f-bf02-47ae-ac34-3ec4ef9c419e', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:35,950 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '2ad87b0f-bf02-47ae-ac34-3ec4ef9c419e', 'username': 'rolete-TestDynamicRoles-test_role_lifecycle_list-49BYOB', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'bNk3cPpwGo9piMBmwXBj2dH8NvY='}
2026-10-09 17:14:35,950 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:14:37,279 - DEBUG - Response : {id : '192a9c95-c234-4b6e-8a15-bf8b6e1808d6', name : 'rolete-TestDynamicRoles-test_role_lifecycle_list-49BYOB', accounttype : 0, roleid : '2ad87b0f-bf02-47ae-ac34-3ec4ef9c419e', roletype : 'User', rolename : 'MarvinFake Role okuharubxx', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:36+0000', user : [{id : '26a282f1-a86c-4506-82bc-b4be97520823', username : 'rolete-TestDynamicRoles-test_role_lifecycle_list-49BYOB', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:37+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_lifecycle_list-49BYOB', accounttype : 0, usersource : 'native', roleid : '2ad87b0f-bf02-47ae-ac34-3ec4ef9c419e', roletype : 'User', rolename : 'MarvinFake Role okuharubxx', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '192a9c95-c234-4b6e-8a15-bf8b6e1808d6', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:14:37,280 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:14:37,280 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:14:37,306 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:14:37,307 - DEBUG - Payload: {'id': 1, 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'w6YGHTmNTwIIz0GfuTutO4e6fjs='}
2026-10-09 17:14:37,307 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-09 17:14:37,328 - DEBUG - Response : [{type : 'Admin', isdefault : True, state : 'enabled', id : '728a7b63-c3f0-11f1-975d-1e002100023e', name : 'Root Admin', description : 'Default root admin role', ispublic : True}]
2026-10-09 17:14:37,328 - DEBUG - Payload: {'id': 2, 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'0ASzjui3BusnYz90AWsKakeXIuE='}
2026-10-09 17:14:37,328 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-09 17:14:37,350 - DEBUG - Response : [{type : 'ResourceAdmin', isdefault : True, state : 'enabled', id : '728a9daf-c3f0-11f1-975d-1e002100023e', name : 'Resource Admin', description : 'Default resource admin role', ispublic : True}]
2026-10-09 17:14:37,350 - DEBUG - Payload: {'id': 3, 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'k1yb56EzUPeAaYALLNSox3vcFKY='}
2026-10-09 17:14:37,350 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-09 17:14:37,373 - DEBUG - Response : [{type : 'DomainAdmin', isdefault : True, state : 'enabled', id : '728abbab-c3f0-11f1-975d-1e002100023e', name : 'Domain Admin', description : 'Default domain admin role', ispublic : True}]
2026-10-09 17:14:37,373 - DEBUG - Payload: {'id': 4, 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'jl2J3GOJgIBKjnL3dgB6SGPYntc='}
2026-10-09 17:14:37,373 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-09 17:14:37,399 - DEBUG - Response : [{type : 'User', isdefault : True, state : 'enabled', id : '728acd28-c3f0-11f1-975d-1e002100023e', name : 'User', description : 'Default user role', ispublic : True}]
2026-10-09 17:14:37,399 - DEBUG - Payload: {'id': '192a9c95-c234-4b6e-8a15-bf8b6e1808d6', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'O3+qqeOacLmC5Td/rURZuTYadvs='}
2026-10-09 17:14:37,399 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:37,445 - DEBUG - === Jobid: 23cda348-1f72-4b2e-bb8a-c9ca6c4734fd Started ===
2026-10-09 17:14:37,446 - DEBUG - Payload: {'jobid': '23cda348-1f72-4b2e-bb8a-c9ca6c4734fd', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'dRXNq8xiSmisk3+eQBEd+W5U4pU='}
2026-10-09 17:14:37,446 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:37,483 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '192a9c95-c234-4b6e-8a15-bf8b6e1808d6', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:37+0000', jobid : '23cda348-1f72-4b2e-bb8a-c9ca6c4734fd', jobstatus : 0}
2026-10-09 17:14:38,484 - DEBUG - === JobId:23cda348-1f72-4b2e-bb8a-c9ca6c4734fd is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:38,485 - DEBUG - Payload: {'jobid': '23cda348-1f72-4b2e-bb8a-c9ca6c4734fd', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'dRXNq8xiSmisk3+eQBEd+W5U4pU='}
2026-10-09 17:14:38,485 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:38,517 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '192a9c95-c234-4b6e-8a15-bf8b6e1808d6', created : '2026-10-09T17:14:37+0000', completed : '2026-10-09T17:14:37+0000', jobid : '23cda348-1f72-4b2e-bb8a-c9ca6c4734fd', jobstatus : 1}
2026-10-09 17:14:38,517 - DEBUG - ===Jobid:23cda348-1f72-4b2e-bb8a-c9ca6c4734fd ; StartTime:Fri Oct  9 17:14:37 2026 ; EndTime:Fri Oct  9 17:14:38 2026 ; TotalTime:-1===
2026-10-09 17:14:38,517 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '192a9c95-c234-4b6e-8a15-bf8b6e1808d6', created : '2026-10-09T17:14:37+0000', completed : '2026-10-09T17:14:37+0000', jobid : '23cda348-1f72-4b2e-bb8a-c9ca6c4734fd', jobstatus : 1}
2026-10-09 17:14:38,518 - DEBUG - Payload: {'id': 'a4d75155-dacd-4e18-97a8-29fc96d417cf', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mhtQn0lYx7ou0drzlr7MmDBLivA='}
2026-10-09 17:14:38,518 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:38,551 - DEBUG - Response : {success : True}
2026-10-09 17:14:38,551 - DEBUG - Payload: {'id': '2ad87b0f-bf02-47ae-ac34-3ec4ef9c419e', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'hpR9/6/E6+mGjNa/qhDoW8Uat4E='}
2026-10-09 17:14:38,551 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:38,635 - DEBUG - Response : {success : True}
2026-10-09 17:14:38,635 - DEBUG - TestCaseName: test_role_lifecycle_list; Time Taken: 2 Seconds; StartTime: Fri Oct  9 17:14:35 2026; EndTime: Fri Oct  9 17:14:38 2026; Result: SUCCESS
2026-10-09 17:14:38,635 - DEBUG - ::::::::::::STARTED : TC: test_role_lifecycle_update :::::::::::
2026-10-09 17:14:38,636 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:38,636 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:38,673 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:38,673 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role 9m9sgw5b1x', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'/OJ0OgsG7IzKUveWzJ6Ae9dlKu4='}
2026-10-09 17:14:38,673 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:38,708 - DEBUG - Response : {type : 'User', state : 'enabled', id : '44a9ce63-276e-44d0-9088-c681fb1c441b', name : 'MarvinFake Role 9m9sgw5b1x', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:38,709 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '44a9ce63-276e-44d0-9088-c681fb1c441b', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'5pcmN1+iUGk2PIjO6LHjZspJOZs='}
2026-10-09 17:14:38,709 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:38,744 - DEBUG - Response : {id : 'a2250778-c4a7-484e-9904-53d700a3df8c', roleid : '44a9ce63-276e-44d0-9088-c681fb1c441b', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:38,744 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '44a9ce63-276e-44d0-9088-c681fb1c441b', 'username': 'rolete-TestDynamicRoles-test_role_lifecycle_update-FAQ0IS', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'yjpH25ECm9sOc0Iu7nBycEgBKn8='}
2026-10-09 17:14:38,744 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:14:40,180 - DEBUG - Response : {id : 'ce17cff8-d63b-4d73-8bbf-c5138b4cefb9', name : 'rolete-TestDynamicRoles-test_role_lifecycle_update-FAQ0IS', accounttype : 0, roleid : '44a9ce63-276e-44d0-9088-c681fb1c441b', roletype : 'User', rolename : 'MarvinFake Role 9m9sgw5b1x', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:39+0000', user : [{id : 'b9730720-59ef-4ca5-af0c-768385add96e', username : 'rolete-TestDynamicRoles-test_role_lifecycle_update-FAQ0IS', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:40+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_lifecycle_update-FAQ0IS', accounttype : 0, usersource : 'native', roleid : '44a9ce63-276e-44d0-9088-c681fb1c441b', roletype : 'User', rolename : 'MarvinFake Role 9m9sgw5b1x', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : 'ce17cff8-d63b-4d73-8bbf-c5138b4cefb9', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:14:40,181 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:14:40,181 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:14:40,206 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:14:40,206 - DEBUG - Payload: {'id': 'ce17cff8-d63b-4d73-8bbf-c5138b4cefb9', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'FATpLUevrnfh+b6zjAxRv6yMjIU='}
2026-10-09 17:14:40,206 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:40,265 - DEBUG - === Jobid: e1de8391-1714-4c92-b29f-b499d7df52a3 Started ===
2026-10-09 17:14:40,266 - DEBUG - Payload: {'jobid': 'e1de8391-1714-4c92-b29f-b499d7df52a3', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'1Igmev5CtK+vg1ggsXzren2KF+s='}
2026-10-09 17:14:40,266 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:40,301 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'ce17cff8-d63b-4d73-8bbf-c5138b4cefb9', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:40+0000', jobid : 'e1de8391-1714-4c92-b29f-b499d7df52a3', jobstatus : 0}
2026-10-09 17:14:41,302 - DEBUG - === JobId:e1de8391-1714-4c92-b29f-b499d7df52a3 is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:41,303 - DEBUG - Payload: {'jobid': 'e1de8391-1714-4c92-b29f-b499d7df52a3', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'1Igmev5CtK+vg1ggsXzren2KF+s='}
2026-10-09 17:14:41,303 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:41,342 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'ce17cff8-d63b-4d73-8bbf-c5138b4cefb9', created : '2026-10-09T17:14:40+0000', completed : '2026-10-09T17:14:40+0000', jobid : 'e1de8391-1714-4c92-b29f-b499d7df52a3', jobstatus : 1}
2026-10-09 17:14:41,342 - DEBUG - ===Jobid:e1de8391-1714-4c92-b29f-b499d7df52a3 ; StartTime:Fri Oct  9 17:14:40 2026 ; EndTime:Fri Oct  9 17:14:41 2026 ; TotalTime:-1===
2026-10-09 17:14:41,342 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'ce17cff8-d63b-4d73-8bbf-c5138b4cefb9', created : '2026-10-09T17:14:40+0000', completed : '2026-10-09T17:14:40+0000', jobid : 'e1de8391-1714-4c92-b29f-b499d7df52a3', jobstatus : 1}
2026-10-09 17:14:41,343 - DEBUG - Payload: {'description': 'Fake role description created after update', 'id': '44a9ce63-276e-44d0-9088-c681fb1c441b', 'name': 'MarvinFakeRoleNewName-cxfc66qrqp', 'type': 'Admin', 'command': 'updateRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'VjfJeMlUtYeUDRltnG7zCDVCkfM='}
2026-10-09 17:14:41,343 - DEBUG - ========Sending GET Cmd : updateRole=======
2026-10-09 17:14:41,384 - DEBUG - Response : {type : 'Admin', state : 'enabled', id : '44a9ce63-276e-44d0-9088-c681fb1c441b', name : 'MarvinFakeRoleNewName-cxfc66qrqp', description : 'Fake role description created after update', ispublic : True}
2026-10-09 17:14:41,385 - DEBUG - Payload: {'id': '44a9ce63-276e-44d0-9088-c681fb1c441b', 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'OOQ4cbAw9Q0VrnRIqbtCZ5klbVE='}
2026-10-09 17:14:41,385 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-09 17:14:41,405 - DEBUG - Response : [{type : 'Admin', isdefault : False, state : 'enabled', id : '44a9ce63-276e-44d0-9088-c681fb1c441b', name : 'MarvinFakeRoleNewName-cxfc66qrqp', description : 'Fake role description created after update', ispublic : True}]
2026-10-09 17:14:41,406 - DEBUG - Payload: {'id': 'ce17cff8-d63b-4d73-8bbf-c5138b4cefb9', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'FATpLUevrnfh+b6zjAxRv6yMjIU='}
2026-10-09 17:14:41,406 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:41,449 - DEBUG - === Jobid: 5ce8d171-f683-46d3-9b75-d8a201d59d8f Started ===
2026-10-09 17:14:41,449 - DEBUG - Payload: {'jobid': '5ce8d171-f683-46d3-9b75-d8a201d59d8f', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'H8H2d3UtG3rNR6e26s/QuADnIdI='}
2026-10-09 17:14:41,449 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:41,490 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'ce17cff8-d63b-4d73-8bbf-c5138b4cefb9', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:41+0000', jobid : '5ce8d171-f683-46d3-9b75-d8a201d59d8f', jobstatus : 0}
2026-10-09 17:14:42,492 - DEBUG - === JobId:5ce8d171-f683-46d3-9b75-d8a201d59d8f is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:42,492 - DEBUG - Payload: {'jobid': '5ce8d171-f683-46d3-9b75-d8a201d59d8f', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'H8H2d3UtG3rNR6e26s/QuADnIdI='}
2026-10-09 17:14:42,492 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:42,524 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'ce17cff8-d63b-4d73-8bbf-c5138b4cefb9', created : '2026-10-09T17:14:41+0000', completed : '2026-10-09T17:14:41+0000', jobid : '5ce8d171-f683-46d3-9b75-d8a201d59d8f', jobstatus : 1}
2026-10-09 17:14:42,525 - DEBUG - ===Jobid:5ce8d171-f683-46d3-9b75-d8a201d59d8f ; StartTime:Fri Oct  9 17:14:41 2026 ; EndTime:Fri Oct  9 17:14:42 2026 ; TotalTime:-1===
2026-10-09 17:14:42,525 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'ce17cff8-d63b-4d73-8bbf-c5138b4cefb9', created : '2026-10-09T17:14:41+0000', completed : '2026-10-09T17:14:41+0000', jobid : '5ce8d171-f683-46d3-9b75-d8a201d59d8f', jobstatus : 1}
2026-10-09 17:14:42,525 - DEBUG - Payload: {'id': 'a2250778-c4a7-484e-9904-53d700a3df8c', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'RLlifOHGsCFgJqwQx+gBFqVx6Qo='}
2026-10-09 17:14:42,525 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:42,558 - DEBUG - Response : {success : True}
2026-10-09 17:14:42,559 - DEBUG - Payload: {'id': '44a9ce63-276e-44d0-9088-c681fb1c441b', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'CoOXN6PoKS+ex+i8+QXKazKHFDs='}
2026-10-09 17:14:42,559 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:42,594 - DEBUG - Response : {success : True}
2026-10-09 17:14:42,595 - DEBUG - TestCaseName: test_role_lifecycle_update; Time Taken: 3 Seconds; StartTime: Fri Oct  9 17:14:38 2026; EndTime: Fri Oct  9 17:14:42 2026; Result: SUCCESS
2026-10-09 17:14:42,595 - DEBUG - ::::::::::::STARTED : TC: test_role_lifecycle_update_role_inuse :::::::::::
2026-10-09 17:14:42,595 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:42,595 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:42,641 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:42,642 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role 04lucoaeuq', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'wgn3Ym5E3N9HWgAsIbA7MCUUXew='}
2026-10-09 17:14:42,642 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:42,680 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'e217a885-eec6-4671-a36c-e1f98d2fa91d', name : 'MarvinFake Role 04lucoaeuq', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:42,680 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'e217a885-eec6-4671-a36c-e1f98d2fa91d', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'bclH/fX+pxX4bJ4bh44HnzYpFTc='}
2026-10-09 17:14:42,680 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:42,713 - DEBUG - Response : {id : 'bddd55f2-ca93-4694-b3a5-2111f4044f10', roleid : 'e217a885-eec6-4671-a36c-e1f98d2fa91d', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:42,714 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': 'e217a885-eec6-4671-a36c-e1f98d2fa91d', 'username': 'rolete-TestDynamicRoles-test_role_lifecycle_update_role_inuse-4VL4BN', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'sr/aRO9cSTv8v23J59WF9w0u42U='}
2026-10-09 17:14:42,714 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:14:43,944 - DEBUG - Response : {id : '7a4660c7-6f7d-4c4f-866e-cb186b402f94', name : 'rolete-TestDynamicRoles-test_role_lifecycle_update_role_inuse-4VL4BN', accounttype : 0, roleid : 'e217a885-eec6-4671-a36c-e1f98d2fa91d', roletype : 'User', rolename : 'MarvinFake Role 04lucoaeuq', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:43+0000', user : [{id : '0c362677-b986-472f-aed9-2893dd6b26c2', username : 'rolete-TestDynamicRoles-test_role_lifecycle_update_role_inuse-4VL4BN', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:43+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_lifecycle_update_role_inuse-4VL4BN', accounttype : 0, usersource : 'native', roleid : 'e217a885-eec6-4671-a36c-e1f98d2fa91d', roletype : 'User', rolename : 'MarvinFake Role 04lucoaeuq', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '7a4660c7-6f7d-4c4f-866e-cb186b402f94', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:14:43,945 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:14:43,945 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:14:43,970 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:14:43,971 - DEBUG - Payload: {'id': 'e217a885-eec6-4671-a36c-e1f98d2fa91d', 'name': 'MarvinFakeRoleNewName-z77ut97tpe', 'type': 'Admin', 'command': 'updateRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'R51xsvljLnpsGAyGpn79ImcRZrk='}
2026-10-09 17:14:43,971 - DEBUG - ========Sending GET Cmd : updateRole=======
2026-10-09 17:14:44,001 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', "marvin.cloudstackException.CloudstackAPIException: Execute cmd: updaterole failed, due to: errorCode: 531, errorText:Found accounts that have role in use, won't allow to change role type\n"]
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: updaterole failed, due to: errorCode: 531, errorText:Found accounts that have role in use, won't allow to change role type
2026-10-09 17:14:44,001 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.updateRole.updateRoleCmd object at 0x7f2246ec9be0> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', "marvin.cloudstackException.CloudstackAPIException: Execute cmd: updaterole failed, due to: errorCode: 531, errorText:Found accounts that have role in use, won't allow to change role type\n"]
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: updaterole failed, due to: errorCode: 531, errorText:Found accounts that have role in use, won't allow to change role type
2026-10-09 17:14:44,001 - DEBUG - Payload: {'id': 'e217a885-eec6-4671-a36c-e1f98d2fa91d', 'name': 'MarvinFakeRoleNewName-z77ut97tpe', 'command': 'updateRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'FaU6u8hzKQBNl50xRgQhjtMuILs='}
2026-10-09 17:14:44,001 - DEBUG - ========Sending GET Cmd : updateRole=======
2026-10-09 17:14:44,036 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'e217a885-eec6-4671-a36c-e1f98d2fa91d', name : 'MarvinFakeRoleNewName-z77ut97tpe', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:44,036 - DEBUG - Payload: {'id': 'e217a885-eec6-4671-a36c-e1f98d2fa91d', 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'j7T/8YJftjxGfw8uViPKhBz7twI='}
2026-10-09 17:14:44,036 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-09 17:14:44,057 - DEBUG - Response : [{type : 'User', isdefault : False, state : 'enabled', id : 'e217a885-eec6-4671-a36c-e1f98d2fa91d', name : 'MarvinFakeRoleNewName-z77ut97tpe', description : 'Fake Role created by Marvin test', ispublic : True}]
2026-10-09 17:14:44,058 - DEBUG - Payload: {'id': '7a4660c7-6f7d-4c4f-866e-cb186b402f94', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'xi/M+Lh4mukK4KYCbBP61fYgAYg='}
2026-10-09 17:14:44,058 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:44,106 - DEBUG - === Jobid: 7518f1c4-b515-4866-b953-2d14e41226be Started ===
2026-10-09 17:14:44,106 - DEBUG - Payload: {'jobid': '7518f1c4-b515-4866-b953-2d14e41226be', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Fs8NqK5wX+CggU9BbfJd39v9eyA='}
2026-10-09 17:14:44,106 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:44,138 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '7a4660c7-6f7d-4c4f-866e-cb186b402f94', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:44+0000', jobid : '7518f1c4-b515-4866-b953-2d14e41226be', jobstatus : 0}
2026-10-09 17:14:45,139 - DEBUG - === JobId:7518f1c4-b515-4866-b953-2d14e41226be is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:45,140 - DEBUG - Payload: {'jobid': '7518f1c4-b515-4866-b953-2d14e41226be', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Fs8NqK5wX+CggU9BbfJd39v9eyA='}
2026-10-09 17:14:45,140 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:45,171 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '7a4660c7-6f7d-4c4f-866e-cb186b402f94', created : '2026-10-09T17:14:44+0000', completed : '2026-10-09T17:14:44+0000', jobid : '7518f1c4-b515-4866-b953-2d14e41226be', jobstatus : 1}
2026-10-09 17:14:45,171 - DEBUG - ===Jobid:7518f1c4-b515-4866-b953-2d14e41226be ; StartTime:Fri Oct  9 17:14:44 2026 ; EndTime:Fri Oct  9 17:14:45 2026 ; TotalTime:-1===
2026-10-09 17:14:45,171 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '7a4660c7-6f7d-4c4f-866e-cb186b402f94', created : '2026-10-09T17:14:44+0000', completed : '2026-10-09T17:14:44+0000', jobid : '7518f1c4-b515-4866-b953-2d14e41226be', jobstatus : 1}
2026-10-09 17:14:45,171 - DEBUG - Payload: {'id': 'bddd55f2-ca93-4694-b3a5-2111f4044f10', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'9X6IsnFcXYBsaz5BfOkGqSaDnSo='}
2026-10-09 17:14:45,172 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:45,201 - DEBUG - Response : {success : True}
2026-10-09 17:14:45,202 - DEBUG - Payload: {'id': 'e217a885-eec6-4671-a36c-e1f98d2fa91d', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'eqbsZ/vOiDagIOJFP9CcdSyE+XU='}
2026-10-09 17:14:45,202 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:45,238 - DEBUG - Response : {success : True}
2026-10-09 17:14:45,239 - DEBUG - TestCaseName: test_role_lifecycle_update_role_inuse; Time Taken: 2 Seconds; StartTime: Fri Oct  9 17:14:42 2026; EndTime: Fri Oct  9 17:14:45 2026; Result: SUCCESS
2026-10-09 17:14:45,239 - DEBUG - ::::::::::::STARTED : TC: test_rolepermission_lifecycle_concurrent_updates :::::::::::
2026-10-09 17:14:45,239 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:45,240 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:45,276 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:45,276 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role 06s1r90293', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Yc4C3Zp2TpJXQr5qiN7bwRTn43s='}
2026-10-09 17:14:45,277 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:45,310 - DEBUG - Response : {type : 'User', state : 'enabled', id : '8b4eefeb-ef58-450e-a30f-81a603582f6d', name : 'MarvinFake Role 06s1r90293', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:45,310 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '8b4eefeb-ef58-450e-a30f-81a603582f6d', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'gW76fsiti5+AdI0PCanK9kq6OcY='}
2026-10-09 17:14:45,310 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:45,348 - DEBUG - Response : {id : '37901eaa-4784-4fe2-b4d4-4fccc9c0b61f', roleid : '8b4eefeb-ef58-450e-a30f-81a603582f6d', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:45,349 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '8b4eefeb-ef58-450e-a30f-81a603582f6d', 'username': 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_concurrent_updates-B9EXD4', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'5KEeZIwP8AzSn33na4Iv4+eibLs='}
2026-10-09 17:14:45,349 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:14:46,653 - DEBUG - Response : {id : '972d542c-5d6f-4def-9977-51f2270a7f48', name : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_concurrent_updates-B9EXD4', accounttype : 0, roleid : '8b4eefeb-ef58-450e-a30f-81a603582f6d', roletype : 'User', rolename : 'MarvinFake Role 06s1r90293', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:46+0000', user : [{id : '890833bd-f24f-4e22-9213-77d91cb87ec1', username : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_concurrent_updates-B9EXD4', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:46+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_concurrent_updates-B9EXD4', accounttype : 0, usersource : 'native', roleid : '8b4eefeb-ef58-450e-a30f-81a603582f6d', roletype : 'User', rolename : 'MarvinFake Role 06s1r90293', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '972d542c-5d6f-4def-9977-51f2270a7f48', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:14:46,654 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:14:46,654 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:14:46,684 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:14:46,684 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '8b4eefeb-ef58-450e-a30f-81a603582f6d', 'rule': 'list*', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Mkvus+ngqU+SabdtHEg1sUS3QdU='}
2026-10-09 17:14:46,684 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:46,726 - DEBUG - Response : {id : 'b46c3e08-c6fb-441b-bc55-5f75546b5d6d', roleid : '8b4eefeb-ef58-450e-a30f-81a603582f6d', rule : 'list*', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:46,727 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '8b4eefeb-ef58-450e-a30f-81a603582f6d', 'rule': '*Vol*', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'pRUEdIrnUlw7Sa8Q1LNIujjpLio='}
2026-10-09 17:14:46,727 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:46,766 - DEBUG - Response : {id : 'bd51b0e5-0227-461d-b9be-ada08402d4d0', roleid : '8b4eefeb-ef58-450e-a30f-81a603582f6d', rule : '*Vol*', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:46,766 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '8b4eefeb-ef58-450e-a30f-81a603582f6d', 'rule': 'listCapabilities', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'DhysixeCZyef4m/nQjlAvk1tgwQ='}
2026-10-09 17:14:46,766 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:46,801 - DEBUG - Response : {id : 'c8633574-e652-468e-bef6-58726e5af586', roleid : '8b4eefeb-ef58-450e-a30f-81a603582f6d', rule : 'listCapabilities', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:46,801 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '8b4eefeb-ef58-450e-a30f-81a603582f6d', 'rule': 'someRule*', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'IdtX/IgZON/RlvEnd06gqg4UVSc='}
2026-10-09 17:14:46,801 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:46,833 - DEBUG - Response : {id : 'c49dd947-41d2-4308-8714-80afbade78fc', roleid : '8b4eefeb-ef58-450e-a30f-81a603582f6d', rule : 'someRule*', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:46,833 - DEBUG - Payload: {'roleid': '8b4eefeb-ef58-450e-a30f-81a603582f6d', 'ruleorder': '37901eaa-4784-4fe2-b4d4-4fccc9c0b61f,bd51b0e5-0227-461d-b9be-ada08402d4d0,c8633574-e652-468e-bef6-58726e5af586,b46c3e08-c6fb-441b-bc55-5f75546b5d6d', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'9rELrZ2pC2yDw6JbhK0OT+o3F/E='}
2026-10-09 17:14:46,833 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-09 17:14:46,875 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', "marvin.cloudstackException.CloudstackAPIException: Execute cmd: updaterolepermission failed, due to: errorCode: 530, errorText:The role's rule permissions list has changed while you were making updates, aborted re-ordering of rules. Please try again.\n"]
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: updaterolepermission failed, due to: errorCode: 530, errorText:The role's rule permissions list has changed while you were making updates, aborted re-ordering of rules. Please try again.
2026-10-09 17:14:46,875 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.updateRolePermission.updateRolePermissionCmd object at 0x7f2246f42910> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', "marvin.cloudstackException.CloudstackAPIException: Execute cmd: updaterolepermission failed, due to: errorCode: 530, errorText:The role's rule permissions list has changed while you were making updates, aborted re-ordering of rules. Please try again.\n"]
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: updaterolepermission failed, due to: errorCode: 530, errorText:The role's rule permissions list has changed while you were making updates, aborted re-ordering of rules. Please try again.
2026-10-09 17:14:46,876 - DEBUG - Payload: {'id': '972d542c-5d6f-4def-9977-51f2270a7f48', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'dYxLos51ITLDMdbFuPD68egyH7g='}
2026-10-09 17:14:46,876 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:46,925 - DEBUG - === Jobid: b2a65335-2198-49e8-a198-8112c438a201 Started ===
2026-10-09 17:14:46,925 - DEBUG - Payload: {'jobid': 'b2a65335-2198-49e8-a198-8112c438a201', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'JbZjH1Wp6r4t70GZIxKrb7uDf+E='}
2026-10-09 17:14:46,925 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:46,964 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '972d542c-5d6f-4def-9977-51f2270a7f48', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:46+0000', jobid : 'b2a65335-2198-49e8-a198-8112c438a201', jobstatus : 0}
2026-10-09 17:14:47,965 - DEBUG - === JobId:b2a65335-2198-49e8-a198-8112c438a201 is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:47,966 - DEBUG - Payload: {'jobid': 'b2a65335-2198-49e8-a198-8112c438a201', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'JbZjH1Wp6r4t70GZIxKrb7uDf+E='}
2026-10-09 17:14:47,966 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:48,010 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '972d542c-5d6f-4def-9977-51f2270a7f48', created : '2026-10-09T17:14:46+0000', completed : '2026-10-09T17:14:47+0000', jobid : 'b2a65335-2198-49e8-a198-8112c438a201', jobstatus : 1}
2026-10-09 17:14:48,011 - DEBUG - ===Jobid:b2a65335-2198-49e8-a198-8112c438a201 ; StartTime:Fri Oct  9 17:14:46 2026 ; EndTime:Fri Oct  9 17:14:48 2026 ; TotalTime:-1===
2026-10-09 17:14:48,011 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '972d542c-5d6f-4def-9977-51f2270a7f48', created : '2026-10-09T17:14:46+0000', completed : '2026-10-09T17:14:47+0000', jobid : 'b2a65335-2198-49e8-a198-8112c438a201', jobstatus : 1}
2026-10-09 17:14:48,011 - DEBUG - Payload: {'id': '37901eaa-4784-4fe2-b4d4-4fccc9c0b61f', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'8YkO+z8/trayaDvATWRYktI5XDw='}
2026-10-09 17:14:48,011 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:48,070 - DEBUG - Response : {success : True}
2026-10-09 17:14:48,070 - DEBUG - Payload: {'id': '8b4eefeb-ef58-450e-a30f-81a603582f6d', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Ol+FjtRO9borxD+WTiKrRW75/NM='}
2026-10-09 17:14:48,070 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:48,128 - DEBUG - Response : {success : True}
2026-10-09 17:14:48,128 - DEBUG - Payload: {'id': 'b46c3e08-c6fb-441b-bc55-5f75546b5d6d', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'vaLaE7UJ6udAtEJfRGnsbbh9xys='}
2026-10-09 17:14:48,128 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:48,148 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterolepermission failed, due to: errorCode: 431, errorText:Unable to execute API command deleterolepermission due to invalid value. Invalid parameter id value=b46c3e08-c6fb-441b-bc55-5f75546b5d6d due to incorrect long value format, or entity does not exist or due to incorrect parameter annotation for the field in api cmd class.\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterolepermission failed, due to: errorCode: 431, errorText:Unable to execute API command deleterolepermission due to invalid value. Invalid parameter id value=b46c3e08-c6fb-441b-bc55-5f75546b5d6d due to incorrect long value format, or entity does not exist or due to incorrect parameter annotation for the field in api cmd class.
2026-10-09 17:14:48,149 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRolePermission.deleteRolePermissionCmd object at 0x7f22470ad2e0> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterolepermission failed, due to: errorCode: 431, errorText:Unable to execute API command deleterolepermission due to invalid value. Invalid parameter id value=b46c3e08-c6fb-441b-bc55-5f75546b5d6d due to incorrect long value format, or entity does not exist or due to incorrect parameter annotation for the field in api cmd class.\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterolepermission failed, due to: errorCode: 431, errorText:Unable to execute API command deleterolepermission due to invalid value. Invalid parameter id value=b46c3e08-c6fb-441b-bc55-5f75546b5d6d due to incorrect long value format, or entity does not exist or due to incorrect parameter annotation for the field in api cmd class.
2026-10-09 17:14:48,149 - DEBUG - Warning! Exception in tearDown: Execute cmd: deleterolepermission failed, due to: errorCode: 431, errorText:Unable to execute API command deleterolepermission due to invalid value. Invalid parameter id value=b46c3e08-c6fb-441b-bc55-5f75546b5d6d due to incorrect long value format, or entity does not exist or due to incorrect parameter annotation for the field in api cmd class.
2026-10-09 17:14:48,149 - DEBUG - TestCaseName: test_rolepermission_lifecycle_concurrent_updates; Time Taken: 2 Seconds; StartTime: Fri Oct  9 17:14:45 2026; EndTime: Fri Oct  9 17:14:48 2026; Result: SUCCESS
2026-10-09 17:14:48,149 - DEBUG - ::::::::::::STARTED : TC: test_rolepermission_lifecycle_create :::::::::::
2026-10-09 17:14:48,150 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:48,150 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:48,185 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:48,186 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role 9a0rcjh6ng', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'CMvTpB+xpcgtWRyNxBcCaXolbXY='}
2026-10-09 17:14:48,186 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:48,220 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'd753d3ce-0e7b-4c11-b511-7e8522a99ad8', name : 'MarvinFake Role 9a0rcjh6ng', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:48,221 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'd753d3ce-0e7b-4c11-b511-7e8522a99ad8', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'N5xVfPl9789/iMZHuLVvTiFba74='}
2026-10-09 17:14:48,221 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:48,254 - DEBUG - Response : {id : 'a18e213a-17e3-41d9-9ccd-5a13febc0a05', roleid : 'd753d3ce-0e7b-4c11-b511-7e8522a99ad8', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:48,254 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': 'd753d3ce-0e7b-4c11-b511-7e8522a99ad8', 'username': 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_create-0RRETF', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'2IhQ1D1DT7y8w4xYv7mut/WNhQg='}
2026-10-09 17:14:48,255 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:14:49,604 - DEBUG - Response : {id : '430f630e-6a08-4f42-bea9-9ab8d0c1e585', name : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_create-0RRETF', accounttype : 0, roleid : 'd753d3ce-0e7b-4c11-b511-7e8522a99ad8', roletype : 'User', rolename : 'MarvinFake Role 9a0rcjh6ng', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:49+0000', user : [{id : 'c9efed10-afa0-4254-936d-09a06ca3957c', username : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_create-0RRETF', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:49+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_create-0RRETF', accounttype : 0, usersource : 'native', roleid : 'd753d3ce-0e7b-4c11-b511-7e8522a99ad8', roletype : 'User', rolename : 'MarvinFake Role 9a0rcjh6ng', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '430f630e-6a08-4f42-bea9-9ab8d0c1e585', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:14:49,605 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:14:49,605 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:14:49,632 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:14:49,633 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'd753d3ce-0e7b-4c11-b511-7e8522a99ad8', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'N5xVfPl9789/iMZHuLVvTiFba74='}
2026-10-09 17:14:49,633 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:49,664 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: createrolepermission failed, due to: errorCode: 531, errorText:Rule already exists for the role: MarvinFake Role 9a0rcjh6ng\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: createrolepermission failed, due to: errorCode: 531, errorText:Rule already exists for the role: MarvinFake Role 9a0rcjh6ng
2026-10-09 17:14:49,664 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.createRolePermission.createRolePermissionCmd object at 0x7f2246ec9be0> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: createrolepermission failed, due to: errorCode: 531, errorText:Rule already exists for the role: MarvinFake Role 9a0rcjh6ng\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: createrolepermission failed, due to: errorCode: 531, errorText:Rule already exists for the role: MarvinFake Role 9a0rcjh6ng
2026-10-09 17:14:49,665 - DEBUG - Payload: {'roleid': 'd753d3ce-0e7b-4c11-b511-7e8522a99ad8', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ouiOMUY7w1fck9hgAgIMhJ5w10s='}
2026-10-09 17:14:49,665 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:14:49,686 - DEBUG - Response : [{id : 'a18e213a-17e3-41d9-9ccd-5a13febc0a05', roleid : 'd753d3ce-0e7b-4c11-b511-7e8522a99ad8', rolename : 'MarvinFake Role 9a0rcjh6ng', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-09 17:14:49,687 - DEBUG - Payload: {'id': '430f630e-6a08-4f42-bea9-9ab8d0c1e585', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'3hxUyLrIb3KZCpoQNmYxIVDCfCI='}
2026-10-09 17:14:49,687 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:49,729 - DEBUG - === Jobid: d1540b00-0fd7-4676-9f6f-fd5112a21aaf Started ===
2026-10-09 17:14:49,730 - DEBUG - Payload: {'jobid': 'd1540b00-0fd7-4676-9f6f-fd5112a21aaf', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'PJcGXVGyOuaCHI21i54cW7WeUWs='}
2026-10-09 17:14:49,730 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:49,773 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '430f630e-6a08-4f42-bea9-9ab8d0c1e585', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:49+0000', jobid : 'd1540b00-0fd7-4676-9f6f-fd5112a21aaf', jobstatus : 0}
2026-10-09 17:14:50,774 - DEBUG - === JobId:d1540b00-0fd7-4676-9f6f-fd5112a21aaf is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:50,775 - DEBUG - Payload: {'jobid': 'd1540b00-0fd7-4676-9f6f-fd5112a21aaf', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'PJcGXVGyOuaCHI21i54cW7WeUWs='}
2026-10-09 17:14:50,775 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:50,804 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '430f630e-6a08-4f42-bea9-9ab8d0c1e585', created : '2026-10-09T17:14:49+0000', completed : '2026-10-09T17:14:49+0000', jobid : 'd1540b00-0fd7-4676-9f6f-fd5112a21aaf', jobstatus : 1}
2026-10-09 17:14:50,804 - DEBUG - ===Jobid:d1540b00-0fd7-4676-9f6f-fd5112a21aaf ; StartTime:Fri Oct  9 17:14:49 2026 ; EndTime:Fri Oct  9 17:14:50 2026 ; TotalTime:-1===
2026-10-09 17:14:50,804 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '430f630e-6a08-4f42-bea9-9ab8d0c1e585', created : '2026-10-09T17:14:49+0000', completed : '2026-10-09T17:14:49+0000', jobid : 'd1540b00-0fd7-4676-9f6f-fd5112a21aaf', jobstatus : 1}
2026-10-09 17:14:50,804 - DEBUG - Payload: {'id': 'a18e213a-17e3-41d9-9ccd-5a13febc0a05', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'k7F20R9/+HkDfuowzViO9XdJ06w='}
2026-10-09 17:14:50,804 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:50,843 - DEBUG - Response : {success : True}
2026-10-09 17:14:50,843 - DEBUG - Payload: {'id': 'd753d3ce-0e7b-4c11-b511-7e8522a99ad8', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'CIrnC+0cpud+ksUNZWU+zkDkVCs='}
2026-10-09 17:14:50,843 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:50,880 - DEBUG - Response : {success : True}
2026-10-09 17:14:50,881 - DEBUG - TestCaseName: test_rolepermission_lifecycle_create; Time Taken: 2 Seconds; StartTime: Fri Oct  9 17:14:48 2026; EndTime: Fri Oct  9 17:14:50 2026; Result: SUCCESS
2026-10-09 17:14:50,881 - DEBUG - ::::::::::::STARTED : TC: test_rolepermission_lifecycle_delete :::::::::::
2026-10-09 17:14:50,882 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:50,882 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:50,915 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:50,916 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role 4up8qt1xl0', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'DyR5pO7hteow6vRoVMNsgsjH/xw='}
2026-10-09 17:14:50,916 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:50,947 - DEBUG - Response : {type : 'User', state : 'enabled', id : '390a4b84-a39f-4aa6-95f1-f42dacdd068b', name : 'MarvinFake Role 4up8qt1xl0', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:50,948 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '390a4b84-a39f-4aa6-95f1-f42dacdd068b', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'lM0/Y/dhvrfbAzQ3uz3jZekcvmE='}
2026-10-09 17:14:50,948 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:50,980 - DEBUG - Response : {id : '1665f75a-c2b9-4c6a-a98e-c1ac61752ece', roleid : '390a4b84-a39f-4aa6-95f1-f42dacdd068b', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:50,981 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '390a4b84-a39f-4aa6-95f1-f42dacdd068b', 'username': 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_delete-DIQ6M9', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ZNK8Llr3RSZapdI2eQd7vYmWmFw='}
2026-10-09 17:14:50,981 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:14:52,229 - DEBUG - Response : {id : '25282c51-86d9-4710-af91-31e46be2632f', name : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_delete-DIQ6M9', accounttype : 0, roleid : '390a4b84-a39f-4aa6-95f1-f42dacdd068b', roletype : 'User', rolename : 'MarvinFake Role 4up8qt1xl0', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:51+0000', user : [{id : 'c6857d5c-2ca3-4d5c-86cf-ba0f89f59e65', username : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_delete-DIQ6M9', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:52+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_delete-DIQ6M9', accounttype : 0, usersource : 'native', roleid : '390a4b84-a39f-4aa6-95f1-f42dacdd068b', roletype : 'User', rolename : 'MarvinFake Role 4up8qt1xl0', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '25282c51-86d9-4710-af91-31e46be2632f', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:14:52,230 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:14:52,230 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:14:52,256 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:14:52,256 - DEBUG - Payload: {'id': '1665f75a-c2b9-4c6a-a98e-c1ac61752ece', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'zy0aoIjafsi4MqnxSEcyT2e5ah4='}
2026-10-09 17:14:52,256 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:52,296 - DEBUG - Response : {success : True}
2026-10-09 17:14:52,297 - DEBUG - Payload: {'roleid': '390a4b84-a39f-4aa6-95f1-f42dacdd068b', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'UM3KrCPy8K8l1UZNgp4zxeG+7fc='}
2026-10-09 17:14:52,297 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:14:52,316 - DEBUG - Response : None
2026-10-09 17:14:52,316 - DEBUG - Payload: {'id': '25282c51-86d9-4710-af91-31e46be2632f', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Y+EnG4faWwM212RzSt4NjJgCKDY='}
2026-10-09 17:14:52,316 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:52,355 - DEBUG - === Jobid: 895e4a6f-dc64-4b36-bf7b-fb9c511390fa Started ===
2026-10-09 17:14:52,355 - DEBUG - Payload: {'jobid': '895e4a6f-dc64-4b36-bf7b-fb9c511390fa', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'yyfPi84J/JZAqdWJFnQGYZxwypM='}
2026-10-09 17:14:52,355 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:52,382 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '25282c51-86d9-4710-af91-31e46be2632f', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:52+0000', jobid : '895e4a6f-dc64-4b36-bf7b-fb9c511390fa', jobstatus : 0}
2026-10-09 17:14:53,384 - DEBUG - === JobId:895e4a6f-dc64-4b36-bf7b-fb9c511390fa is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:53,384 - DEBUG - Payload: {'jobid': '895e4a6f-dc64-4b36-bf7b-fb9c511390fa', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'yyfPi84J/JZAqdWJFnQGYZxwypM='}
2026-10-09 17:14:53,384 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:53,418 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '25282c51-86d9-4710-af91-31e46be2632f', created : '2026-10-09T17:14:52+0000', completed : '2026-10-09T17:14:52+0000', jobid : '895e4a6f-dc64-4b36-bf7b-fb9c511390fa', jobstatus : 1}
2026-10-09 17:14:53,419 - DEBUG - ===Jobid:895e4a6f-dc64-4b36-bf7b-fb9c511390fa ; StartTime:Fri Oct  9 17:14:52 2026 ; EndTime:Fri Oct  9 17:14:53 2026 ; TotalTime:-1===
2026-10-09 17:14:53,419 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '25282c51-86d9-4710-af91-31e46be2632f', created : '2026-10-09T17:14:52+0000', completed : '2026-10-09T17:14:52+0000', jobid : '895e4a6f-dc64-4b36-bf7b-fb9c511390fa', jobstatus : 1}
2026-10-09 17:14:53,419 - DEBUG - Payload: {'id': '390a4b84-a39f-4aa6-95f1-f42dacdd068b', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'54leEDYJqzyYvPRZRcxzj0RMFnI='}
2026-10-09 17:14:53,419 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:53,457 - DEBUG - Response : {success : True}
2026-10-09 17:14:53,457 - DEBUG - TestCaseName: test_rolepermission_lifecycle_delete; Time Taken: 2 Seconds; StartTime: Fri Oct  9 17:14:50 2026; EndTime: Fri Oct  9 17:14:53 2026; Result: SUCCESS
2026-10-09 17:14:53,458 - DEBUG - ::::::::::::STARTED : TC: test_rolepermission_lifecycle_list :::::::::::
2026-10-09 17:14:53,458 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:53,458 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:53,495 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:53,496 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role rj2cv40v78', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'4m8VTC8maEBCozLbDHBLLILUqPA='}
2026-10-09 17:14:53,496 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:53,531 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'a46d87eb-4eec-4c0b-8369-2f4c58d67566', name : 'MarvinFake Role rj2cv40v78', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:53,532 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'a46d87eb-4eec-4c0b-8369-2f4c58d67566', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'0ATYK3IjF4WYf6TBPQdzmKlSh/o='}
2026-10-09 17:14:53,532 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:53,565 - DEBUG - Response : {id : '3c5ca02a-3c7d-48e9-85a3-3b44da640074', roleid : 'a46d87eb-4eec-4c0b-8369-2f4c58d67566', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:53,566 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': 'a46d87eb-4eec-4c0b-8369-2f4c58d67566', 'username': 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_list-D282YK', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mctee569jjQLpjNqTWD6PQQXR2Q='}
2026-10-09 17:14:53,566 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:14:54,867 - DEBUG - Response : {id : 'e6f8f335-05dd-4d06-b35c-108343255705', name : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_list-D282YK', accounttype : 0, roleid : 'a46d87eb-4eec-4c0b-8369-2f4c58d67566', roletype : 'User', rolename : 'MarvinFake Role rj2cv40v78', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:54+0000', user : [{id : 'a2f68995-b4ad-4b73-ab23-c35ec4114df6', username : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_list-D282YK', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:54+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_list-D282YK', accounttype : 0, usersource : 'native', roleid : 'a46d87eb-4eec-4c0b-8369-2f4c58d67566', roletype : 'User', rolename : 'MarvinFake Role rj2cv40v78', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : 'e6f8f335-05dd-4d06-b35c-108343255705', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:14:54,867 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:14:54,867 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:14:54,894 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:14:54,894 - DEBUG - Payload: {'roleid': 1, 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'iqrA2f+nNAtV4fjpw78YniIYNvk='}
2026-10-09 17:14:54,894 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:14:54,917 - DEBUG - Response : [{id : '72da9994-c3f0-11f1-975d-1e002100023e', roleid : '728a7b63-c3f0-11f1-975d-1e002100023e', rolename : 'Root Admin', rule : '*', permission : 'allow'}]
2026-10-09 17:14:54,917 - DEBUG - Payload: {'roleid': 2, 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'hnBhND1Q8Tdz6C92LpIHbL2TG6g='}
2026-10-09 17:14:54,918 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:14:54,951 - DEBUG - Response : [{id : '72dab424-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'activateProject', permission : 'allow'}, {id : '7cb5dc43-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'addAnnotation', permission : 'allow'}, {id : '838380d1-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'assignVolume', permission : 'allow'}, {id : '7cb58f0e-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listAnnotations', permission : 'allow'}, {id : '7cb6419e-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'removeAnnotation', permission : 'allow'}, {id : '72dac54d-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'addAccountToProject', permission : 'allow'}, {id : '72dad52b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'addHost', permission : 'allow'}, {id : '72dae253-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'addIpToNic', permission : 'allow'}, {id : '72daf019-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'addLdapConfiguration', permission : 'allow'}, {id : '72dafff4-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'addNicToVirtualMachine', permission : 'allow'}, {id : '72db0def-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'addVpnUser', permission : 'allow'}, {id : '72db1d6a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'archiveEvents', permission : 'allow'}, {id : '72db2bd5-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'assignCertToLoadBalancer', permission : 'allow'}, {id : '72db3920-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'assignToGlobalLoadBalancerRule', permission : 'allow'}, {id : '72db4937-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'assignToLoadBalancerRule', permission : 'allow'}, {id : '72db583b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'assignVirtualMachine', permission : 'allow'}, {id : '72db6669-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'associateIpAddress', permission : 'allow'}, {id : '72db83cb-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'attachIso', permission : 'allow'}, {id : '72db91d0-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'attachVolume', permission : 'allow'}, {id : '72db9d46-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'authorizeSamlSso', permission : 'allow'}, {id : '72dba9d2-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'authorizeSecurityGroupEgress', permission : 'allow'}, {id : '72dbb53a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'authorizeSecurityGroupIngress', permission : 'allow'}, {id : '72dbc119-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'changeServiceForRouter', permission : 'allow'}, {id : '72dbcc09-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'changeServiceForVirtualMachine', permission : 'allow'}, {id : '72dbd6a8-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'configureInternalLoadBalancerElement', permission : 'allow'}, {id : '72dbe1ac-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'configureOvsElement', permission : 'allow'}, {id : '72dbecaf-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'configureVirtualRouterElement', permission : 'allow'}, {id : '72dbf808-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'copyIso', permission : 'allow'}, {id : '72dc02a5-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'copyTemplate', permission : 'allow'}, {id : '72dc0db9-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createAccount', permission : 'allow'}, {id : '72dc1809-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createAffinityGroup', permission : 'allow'}, {id : '72dc227b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createAutoScalePolicy', permission : 'allow'}, {id : '72dc2e08-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createAutoScaleVmGroup', permission : 'allow'}, {id : '72dc38e1-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createAutoScaleVmProfile', permission : 'allow'}, {id : '72dc4461-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createCondition', permission : 'allow'}, {id : '72dc4fe3-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createDiskOffering', permission : 'allow'}, {id : '72dc5bd5-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createEgressFirewallRule', permission : 'allow'}, {id : '72dc66cf-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createFirewallRule', permission : 'allow'}, {id : '72dc7200-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createGlobalLoadBalancerRule', permission : 'allow'}, {id : '72dc7deb-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createInstanceGroup', permission : 'allow'}, {id : '72dc8af5-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createInternalLoadBalancerElement', permission : 'allow'}, {id : '72dc96b9-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createIpForwardingRule', permission : 'allow'}, {id : '72dca241-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createLBHealthCheckPolicy', permission : 'allow'}, {id : '72dcaccb-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createLBStickinessPolicy', permission : 'allow'}, {id : '72dcb74e-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createLoadBalancer', permission : 'allow'}, {id : '72dcc1e9-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createLoadBalancerRule', permission : 'allow'}, {id : '72dcd971-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createNetwork', permission : 'allow'}, {id : '72dce509-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createNetworkACL', permission : 'allow'}, {id : '72dcefe3-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createNetworkACLList', permission : 'allow'}, {id : '72dcfa6c-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createOvsElement', permission : 'allow'}, {id : '72dd11af-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createPortForwardingRule', permission : 'allow'}, {id : '72dd1e33-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createProject', permission : 'allow'}, {id : '72dd28f9-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createRemoteAccessVpn', permission : 'allow'}, {id : '72dd3360-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createSSHKeyPair', permission : 'allow'}, {id : '72dd3e0b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createSecurityGroup', permission : 'allow'}, {id : '72dd487f-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createServiceOffering', permission : 'allow'}, {id : '72dd531c-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createSnapshot', permission : 'allow'}, {id : '72dd5e96-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createSnapshotPolicy', permission : 'allow'}, {id : '72dd6a98-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createStaticRoute', permission : 'allow'}, {id : '72dd76e6-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createTags', permission : 'allow'}, {id : '72dd82cf-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createTemplate', permission : 'allow'}, {id : '72dd8dfb-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createUser', permission : 'allow'}, {id : '72dd989a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createVMSnapshot', permission : 'allow'}, {id : '72dda313-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createVPC', permission : 'allow'}, {id : '72ddadaf-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createVirtualRouterElement', permission : 'allow'}, {id : '72ddb9e9-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createVolume', permission : 'allow'}, {id : '72ddcf55-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createVpnConnection', permission : 'allow'}, {id : '72ddda7f-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createVpnCustomerGateway', permission : 'allow'}, {id : '72dde566-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createVpnGateway', permission : 'allow'}, {id : '72ddefd9-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteAccount', permission : 'allow'}, {id : '72ddfa58-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteAccountFromProject', permission : 'allow'}, {id : '72de063e-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteAffinityGroup', permission : 'allow'}, {id : '72de107e-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteAutoScalePolicy', permission : 'allow'}, {id : '72de1aa6-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteAutoScaleVmGroup', permission : 'allow'}, {id : '72de2626-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteAutoScaleVmProfile', permission : 'allow'}, {id : '72de3209-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteCondition', permission : 'allow'}, {id : '72de3cad-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteDiskOffering', permission : 'allow'}, {id : '72de47f6-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteEgressFirewallRule', permission : 'allow'}, {id : '72de5394-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteEvents', permission : 'allow'}, {id : '72de5e87-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteFirewallRule', permission : 'allow'}, {id : '72de6a2c-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteGlobalLoadBalancerRule', permission : 'allow'}, {id : '72de7463-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteHost', permission : 'allow'}, {id : '72de81ad-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteInstanceGroup', permission : 'allow'}, {id : '72de8c15-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteIpForwardingRule', permission : 'allow'}, {id : '72de964e-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteIso', permission : 'allow'}, {id : '72dea1d1-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteLBHealthCheckPolicy', permission : 'allow'}, {id : '72deac4c-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteLBStickinessPolicy', permission : 'allow'}, {id : '72deb8ee-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteLdapConfiguration', permission : 'allow'}, {id : '72dec357-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteLoadBalancer', permission : 'allow'}, {id : '72deced2-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteLoadBalancerRule', permission : 'allow'}, {id : '72ded916-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteNetwork', permission : 'allow'}, {id : '72dee34a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteNetworkACL', permission : 'allow'}, {id : '72deedf6-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteNetworkACLList', permission : 'allow'}, {id : '72df0689-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deletePortForwardingRule', permission : 'allow'}, {id : '72df141b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteProject', permission : 'allow'}, {id : '72df1f7b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteProjectInvitation', permission : 'allow'}, {id : '72df29d2-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteRemoteAccessVpn', permission : 'allow'}, {id : '72df341d-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteSSHKeyPair', permission : 'allow'}, {id : '72df3fa7-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteSecurityGroup', permission : 'allow'}, {id : '72df49f7-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteServiceOffering', permission : 'allow'}, {id : '767a328c-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'moveNetworkAclItem', permission : 'allow'}, {id : '72df5439-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteSnapshot', permission : 'allow'}, {id : '72df5f79-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteSnapshotPolicies', permission : 'allow'}, {id : '72df6b41-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteSslCert', permission : 'allow'}, {id : '72df75ce-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteStaticRoute', permission : 'allow'}, {id : '72df8076-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteTags', permission : 'allow'}, {id : '72df8c1b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteTemplate', permission : 'allow'}, {id : '72df97cd-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteUser', permission : 'allow'}, {id : '72dfa226-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteVMSnapshot', permission : 'allow'}, {id : '72dfad0b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteVPC', permission : 'allow'}, {id : '72dfb84e-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteVolume', permission : 'allow'}, {id : '72dfc2d3-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteVpnConnection', permission : 'allow'}, {id : '72dfcdea-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteVpnCustomerGateway', permission : 'allow'}, {id : '72dfd966-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteVpnGateway', permission : 'allow'}, {id : '72dfe42b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deployVirtualMachine', permission : 'allow'}, {id : '72dff8af-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'destroyRouter', permission : 'allow'}, {id : '72e003a6-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'destroyVirtualMachine', permission : 'allow'}, {id : '72e0180c-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'detachIso', permission : 'allow'}, {id : '72e022ab-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'detachVolume', permission : 'allow'}, {id : '72e02ebf-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'disableAccount', permission : 'allow'}, {id : '72e0392f-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'disableAutoScaleVmGroup', permission : 'allow'}, {id : '72e04519-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'disableStaticNat', permission : 'allow'}, {id : '72e0505b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'disableUser', permission : 'allow'}, {id : '72e05ad9-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'disassociateIpAddress', permission : 'allow'}, {id : '72e0740a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'enableAccount', permission : 'allow'}, {id : '72e07f73-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'enableAutoScaleVmGroup', permission : 'allow'}, {id : '72e08a23-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'enableStaticNat', permission : 'allow'}, {id : '72e095ac-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'enableUser', permission : 'allow'}, {id : '72e0a228-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'expungeVirtualMachine', permission : 'allow'}, {id : '72e0ad36-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'extractIso', permission : 'allow'}, {id : '72e0b7a8-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'extractTemplate', permission : 'allow'}, {id : '72e0c25b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'extractVolume', permission : 'allow'}, {id : '72e0cd35-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'getApiLimit', permission : 'allow'}, {id : '72e0d759-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'getCloudIdentifier', permission : 'allow'}, {id : '72e0e194-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'getSolidFireAccountId', permission : 'allow'}, {id : '72e0ed73-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'getSolidFireVolumeAccessGroupId', permission : 'allow'}, {id : '72e0f8ad-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'getSolidFireVolumeIscsiName', permission : 'allow'}, {id : '72e103a9-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'getSolidFireVolumeSize', permission : 'allow'}, {id : '72e10f4d-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'getUploadParamsForTemplate', permission : 'allow'}, {id : '72e119bd-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'getUploadParamsForVolume', permission : 'allow'}, {id : '72e123f9-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'getVMPassword', permission : 'allow'}, {id : '72e1d305-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'getVirtualMachineUserData', permission : 'allow'}, {id : '72e1e37f-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'importLdapUsers', permission : 'allow'}, {id : '72e1ef41-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'ldapCreateAccount', permission : 'allow'}, {id : '72e1fab1-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'linkDomainToLdap', permission : 'allow'}, {id : '72e205d6-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listAccounts', permission : 'allow'}, {id : '72e21083-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listAffinityGroupTypes', permission : 'allow'}, {id : '72e21bca-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listAffinityGroups', permission : 'allow'}, {id : '72e22749-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listAlerts', permission : 'allow'}, {id : '72e232da-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listApis', permission : 'allow'}, {id : '72e23dab-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listAsyncJobs', permission : 'allow'}, {id : '72e248e2-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listAutoScalePolicies', permission : 'allow'}, {id : '72e253e9-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listAutoScaleVmGroups', permission : 'allow'}, {id : '72e25e95-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listAutoScaleVmProfiles', permission : 'allow'}, {id : '72e26ade-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listCapabilities', permission : 'allow'}, {id : '72e27868-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listCapacity', permission : 'allow'}, {id : '72e287e2-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listClusters', permission : 'allow'}, {id : '72e29904-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listConditions', permission : 'allow'}, {id : '72e2a7e8-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listCounters', permission : 'allow'}, {id : '72e2b4f3-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listDiskOfferings', permission : 'allow'}, {id : '72e2c487-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listDomainChildren', permission : 'allow'}, {id : '72e2cfcc-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listDomains', permission : 'allow'}, {id : '72e2da85-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listEgressFirewallRules', permission : 'allow'}, {id : '72e2e736-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listEventTypes', permission : 'allow'}, {id : '72e2f2c5-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listEvents', permission : 'allow'}, {id : '72e2fdc0-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listFirewallRules', permission : 'allow'}, {id : '72e3097d-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listGlobalLoadBalancerRules', permission : 'allow'}, {id : '72e318d6-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listHostTags', permission : 'allow'}, {id : '72e32686-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listHosts', permission : 'allow'}, {id : '72e333a1-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listHypervisors', permission : 'allow'}, {id : '72e33fc3-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listInstanceGroups', permission : 'allow'}, {id : '72e34c1a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listInternalLoadBalancerElements', permission : 'allow'}, {id : '72e35a08-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listIpForwardingRules', permission : 'allow'}, {id : '72e36785-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listIsoPermissions', permission : 'allow'}, {id : '72e3733d-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listIsos', permission : 'allow'}, {id : '72e37db9-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listLBHealthCheckPolicies', permission : 'allow'}, {id : '72e38a33-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listLBStickinessPolicies', permission : 'allow'}, {id : '72e3967b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listLdapConfigurations', permission : 'allow'}, {id : '72e3a2e7-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listLdapUsers', permission : 'allow'}, {id : '72e3af99-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listLoadBalancerRuleInstances', permission : 'allow'}, {id : '72e3ba5a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listLoadBalancerRules', permission : 'allow'}, {id : '72e3c7dc-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listLoadBalancers', permission : 'allow'}, {id : '72e3e20a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listNetworkACLLists', permission : 'allow'}, {id : '72e3ee54-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listNetworkACLs', permission : 'allow'}, {id : '72e3fc1e-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listNetworkOfferings', permission : 'allow'}, {id : '72e40886-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listNetworks', permission : 'allow'}, {id : '72e413a4-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listNics', permission : 'allow'}, {id : '72e42120-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listOsCategories', permission : 'allow'}, {id : '72e42f5c-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listOsTypes', permission : 'allow'}, {id : '72e43b47-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listOvsElements', permission : 'allow'}, {id : '72e44723-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listPods', permission : 'allow'}, {id : '72e45c2e-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listPortForwardingRules', permission : 'allow'}, {id : '72e46661-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listPrivateGateways', permission : 'allow'}, {id : '72e471d6-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listProjectAccounts', permission : 'allow'}, {id : '72e47d30-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listProjectInvitations', permission : 'allow'}, {id : '72e489fe-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listProjects', permission : 'allow'}, {id : '72e4972b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listPublicIpAddresses', permission : 'allow'}, {id : '72e4a389-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listRegions', permission : 'allow'}, {id : '72e4aec8-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listRemoteAccessVpns', permission : 'allow'}, {id : '72e4bb66-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listResourceDetails', permission : 'allow'}, {id : '72e4c731-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listResourceLimits', permission : 'allow'}, {id : '72e4d317-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listRouters', permission : 'allow'}, {id : '72e4e0cc-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listSSHKeyPairs', permission : 'allow'}, {id : '72e4ee78-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listSamlAuthorization', permission : 'allow'}, {id : '72e4f9f3-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listSecurityGroups', permission : 'allow'}, {id : '72e5051d-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listServiceOfferings', permission : 'allow'}, {id : '72e5137c-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listSnapshotPolicies', permission : 'allow'}, {id : '72e51f41-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listSnapshots', permission : 'allow'}, {id : '72e52a1e-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listSslCerts', permission : 'allow'}, {id : '72e5380c-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listStaticRoutes', permission : 'allow'}, {id : '72e54655-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listStoragePools', permission : 'allow'}, {id : '72e5513f-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listStorageProviders', permission : 'allow'}, {id : '72e5ec09-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listStorageTags', permission : 'allow'}, {id : '72e5fd29-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listSystemVms', permission : 'allow'}, {id : '72e60b9e-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listTags', permission : 'allow'}, {id : '72e6181a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listTemplatePermissions', permission : 'allow'}, {id : '72e62458-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listTemplates', permission : 'allow'}, {id : '72e636eb-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listUsageRecords', permission : 'allow'}, {id : '72e64584-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listUsers', permission : 'allow'}, {id : '72e65199-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listVMSnapshot', permission : 'allow'}, {id : '72e65e78-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listVPCOfferings', permission : 'allow'}, {id : '72e66a64-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listVPCs', permission : 'allow'}, {id : '72e677e5-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listVirtualMachines', permission : 'allow'}, {id : '72e682d2-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listVirtualRouterElements', permission : 'allow'}, {id : '72e68f9b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listVolumes', permission : 'allow'}, {id : '72e6a52b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listVpnConnections', permission : 'allow'}, {id : '72e6b1b2-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listVpnCustomerGateways', permission : 'allow'}, {id : '72e6bf4d-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listVpnGateways', permission : 'allow'}, {id : '72e6ca63-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listVpnUsers', permission : 'allow'}, {id : '72e6d5d1-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listZones', permission : 'allow'}, {id : '72e6e481-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'lockAccount', permission : 'allow'}, {id : '72e6ef39-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'lockUser', permission : 'allow'}, {id : '72e71525-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'queryAsyncJobResult', permission : 'allow'}, {id : '72e72193-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'quotaBalance', permission : 'allow'}, {id : '72e72eba-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'quotaIsEnabled', permission : 'allow'}, {id : '8cd59279-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'quotaCreditsList', permission : 'allow'}, {id : '93ccd9d5-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'quotaResourceStatement', permission : 'allow'}, {id : '72e73c79-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'quotaStatement', permission : 'allow'}, {id : '72e74749-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'quotaSummary', permission : 'allow'}, {id : '72e753ce-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'quotaTariffList', permission : 'allow'}, {id : '72e75f84-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'rebootRouter', permission : 'allow'}, {id : '72e76a58-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'rebootVirtualMachine', permission : 'allow'}, {id : '72e77518-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'recoverVirtualMachine', permission : 'allow'}, {id : '72e780a5-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'registerIso', permission : 'allow'}, {id : '72e78b4a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'registerSSHKeyPair', permission : 'allow'}, {id : '72e79633-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'registerTemplate', permission : 'allow'}, {id : '72e7a138-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'registerUserKeys', permission : 'allow'}, {id : '72e7aba7-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'removeCertFromLoadBalancer', permission : 'allow'}, {id : '72e7b661-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'removeFromGlobalLoadBalancerRule', permission : 'allow'}, {id : '72e7c154-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'removeFromLoadBalancerRule', permission : 'allow'}, {id : '72e7d08f-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'removeIpFromNic', permission : 'allow'}, {id : '72e7dbac-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'removeNicFromVirtualMachine', permission : 'allow'}, {id : '72e7e5f1-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'removeVpnUser', permission : 'allow'}, {id : '72e7f106-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'replaceNetworkACLList', permission : 'allow'}, {id : '72e7ffa1-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'resetPasswordForVirtualMachine', permission : 'allow'}, {id : '72e80a3a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'resetSSHKeyForVirtualMachine', permission : 'allow'}, {id : '72e815b5-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'resetVpnConnection', permission : 'allow'}, {id : '72e82105-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'resizeVolume', permission : 'allow'}, {id : '72e82bb4-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'restartNetwork', permission : 'allow'}, {id : '72e8371c-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'restartVPC', permission : 'allow'}, {id : '72e84403-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'restoreVirtualMachine', permission : 'allow'}, {id : '72e84fcf-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'revertSnapshot', permission : 'allow'}, {id : '72e85b3c-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'revertToVMSnapshot', permission : 'allow'}, {id : '72e86761-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'revokeSecurityGroupEgress', permission : 'allow'}, {id : '72e87215-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'revokeSecurityGroupIngress', permission : 'allow'}, {id : '72e87ca1-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'scaleVirtualMachine', permission : 'allow'}, {id : '72e887b8-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'startRouter', permission : 'allow'}, {id : '72e8930c-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'startVirtualMachine', permission : 'allow'}, {id : '72e89d7d-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'stopRouter', permission : 'allow'}, {id : '72e8a85a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'stopVirtualMachine', permission : 'allow'}, {id : '72e8b396-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'suspendProject', permission : 'allow'}, {id : '72e8be57-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateAccount', permission : 'allow'}, {id : '72e8c8c0-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateAutoScalePolicy', permission : 'allow'}, {id : '72e8d34c-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateAutoScaleVmGroup', permission : 'allow'}, {id : '72e8de5a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateAutoScaleVmProfile', permission : 'allow'}, {id : '72e8e8a6-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateDefaultNicForVirtualMachine', permission : 'allow'}, {id : '72e8f543-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateDiskOffering', permission : 'allow'}, {id : '72e90069-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateEgressFirewallRule', permission : 'allow'}, {id : '72e90afc-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateFirewallRule', permission : 'allow'}, {id : '72e91554-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateGlobalLoadBalancerRule', permission : 'allow'}, {id : '72e91f7d-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateInstanceGroup', permission : 'allow'}, {id : '72e92a73-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateIpAddress', permission : 'allow'}, {id : '72e93551-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateIso', permission : 'allow'}, {id : '72e9410a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateIsoPermissions', permission : 'allow'}, {id : '72e94c2c-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateLBHealthCheckPolicy', permission : 'allow'}, {id : '72e95710-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateLBStickinessPolicy', permission : 'allow'}, {id : '72e9619c-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateLoadBalancer', permission : 'allow'}, {id : '72e96bd8-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateLoadBalancerRule', permission : 'allow'}, {id : '72e976c2-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateNetwork', permission : 'allow'}, {id : '72e9812d-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateNetworkACLItem', permission : 'allow'}, {id : '72e98b56-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateNetworkACLList', permission : 'allow'}, {id : '72e99564-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updatePortForwardingRule', permission : 'allow'}, {id : '72e9a033-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateProject', permission : 'allow'}, {id : '72e9aae3-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateProjectInvitation', permission : 'allow'}, {id : '72e9b57a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateRemoteAccessVpn', permission : 'allow'}, {id : '72e9c000-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateResourceCount', permission : 'allow'}, {id : '72e9cb6b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateResourceLimit', permission : 'allow'}, {id : '72e9d893-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateServiceOffering', permission : 'allow'}, {id : '72e9e8af-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateSnapshotPolicy', permission : 'allow'}, {id : '72e9f3ab-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateTemplate', permission : 'allow'}, {id : '72e9fe07-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateTemplatePermissions', permission : 'allow'}, {id : '72ea08eb-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateUser', permission : 'allow'}, {id : '72ea1488-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateVMAffinityGroup', permission : 'allow'}, {id : '72ea1f11-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateVPC', permission : 'allow'}, {id : '72ea29a9-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateVirtualMachine', permission : 'allow'}, {id : '72ea3452-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateVmNicIp', permission : 'allow'}, {id : '72ea4039-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateVpnConnection', permission : 'allow'}, {id : '72ea4b3a-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateVpnCustomerGateway', permission : 'allow'}, {id : '72ea57f9-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'updateVpnGateway', permission : 'allow'}, {id : '72eb7d2e-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'uploadSslCert', permission : 'allow'}, {id : '72eb8f04-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'uploadVolume', permission : 'allow'}, {id : '925d4095-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'deleteUserKeys', permission : 'allow'}, {id : '925eb70b-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'listUserKeyRules', permission : 'allow'}, {id : '749018fd-c3f0-11f1-975d-1e002100023e', roleid : '728a9daf-c3f0-11f1-975d-1e002100023e', rolename : 'Resource Admin', rule : 'createSnapshotFromVMSnapshot', permission : 'allow'}]
2026-10-09 17:14:54,952 - DEBUG - Payload: {'roleid': 3, 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'FUaTDeq5ya0ba/xjiPvG6yMI/kk='}
2026-10-09 17:14:54,952 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:14:54,992 - DEBUG - Response : [{id : '72eb9cb1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'activateProject', permission : 'allow'}, {id : '7cb76a97-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'addAnnotation', permission : 'allow'}, {id : '83839c0e-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'assignVolume', permission : 'allow'}, {id : '83509c69-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'isAccountAllowedToCreateOfferingsWithTags', permission : 'allow'}, {id : '7cb6d0d8-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listAnnotations', permission : 'allow'}, {id : '7cb7adb2-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'removeAnnotation', permission : 'allow'}, {id : '72eba864-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'addAccountToProject', permission : 'allow'}, {id : '72ebb3bb-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'addIpToNic', permission : 'allow'}, {id : '72ebbfeb-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'addNicToVirtualMachine', permission : 'allow'}, {id : '72ebcb6d-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'addVpnUser', permission : 'allow'}, {id : '72ebd702-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'archiveEvents', permission : 'allow'}, {id : '72ebe28d-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'assignCertToLoadBalancer', permission : 'allow'}, {id : '72ebee28-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'assignToGlobalLoadBalancerRule', permission : 'allow'}, {id : '72ebf89e-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'assignToLoadBalancerRule', permission : 'allow'}, {id : '72ec0345-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'assignVirtualMachine', permission : 'allow'}, {id : '72ec0eb1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'associateIpAddress', permission : 'allow'}, {id : '72ec2449-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'attachIso', permission : 'allow'}, {id : '72ec2ee2-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'attachVolume', permission : 'allow'}, {id : '72ec3b00-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'authorizeSamlSso', permission : 'allow'}, {id : '72ec45e4-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'authorizeSecurityGroupEgress', permission : 'allow'}, {id : '72ec5151-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'authorizeSecurityGroupIngress', permission : 'allow'}, {id : '72ec5f82-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'changeServiceForRouter', permission : 'allow'}, {id : '72ec6bbd-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'changeServiceForVirtualMachine', permission : 'allow'}, {id : '72ec77c8-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'configureInternalLoadBalancerElement', permission : 'allow'}, {id : '72ec84f6-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'configureOvsElement', permission : 'allow'}, {id : '72ec9000-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'configureVirtualRouterElement', permission : 'allow'}, {id : '72ec9aa2-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'copyIso', permission : 'allow'}, {id : '72eca59d-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'copyTemplate', permission : 'allow'}, {id : '72ecb14a-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createAccount', permission : 'allow'}, {id : '72ecbc9c-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createAffinityGroup', permission : 'allow'}, {id : '72eccc23-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createAutoScalePolicy', permission : 'allow'}, {id : '72ecde43-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createAutoScaleVmGroup', permission : 'allow'}, {id : '72ecf00d-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createAutoScaleVmProfile', permission : 'allow'}, {id : '72ecff7e-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createCondition', permission : 'allow'}, {id : '72ed0ebe-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createDiskOffering', permission : 'allow'}, {id : '72ed1dec-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createEgressFirewallRule', permission : 'allow'}, {id : '72ed2c46-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createFirewallRule', permission : 'allow'}, {id : '72ed386e-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createGlobalLoadBalancerRule', permission : 'allow'}, {id : '72ed4619-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createInstanceGroup', permission : 'allow'}, {id : '72ed5536-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createInternalLoadBalancerElement', permission : 'allow'}, {id : '72ed6267-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createIpForwardingRule', permission : 'allow'}, {id : '72ed6eee-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createLBHealthCheckPolicy', permission : 'allow'}, {id : '72ed79e3-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createLBStickinessPolicy', permission : 'allow'}, {id : '72ed84f8-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createLoadBalancer', permission : 'allow'}, {id : '72ed934d-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createLoadBalancerRule', permission : 'allow'}, {id : '72edab17-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createNetwork', permission : 'allow'}, {id : '72ee8dbf-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createNetworkACL', permission : 'allow'}, {id : '72eea020-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createNetworkACLList', permission : 'allow'}, {id : '72eeb0eb-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createOvsElement', permission : 'allow'}, {id : '72eeceee-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createPortForwardingRule', permission : 'allow'}, {id : '72eee066-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createProject', permission : 'allow'}, {id : '72eef035-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createRemoteAccessVpn', permission : 'allow'}, {id : '72ef0087-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createSSHKeyPair', permission : 'allow'}, {id : '72ef105e-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createSecurityGroup', permission : 'allow'}, {id : '72ef1e0e-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createServiceOffering', permission : 'allow'}, {id : '72ef2db9-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createSnapshot', permission : 'allow'}, {id : '72ef3de2-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createSnapshotPolicy', permission : 'allow'}, {id : '72ef4c4e-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createStaticRoute', permission : 'allow'}, {id : '72ef5851-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createTags', permission : 'allow'}, {id : '72ef63fb-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createTemplate', permission : 'allow'}, {id : '72ef7001-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createUser', permission : 'allow'}, {id : '72ef7c0b-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createVMSnapshot', permission : 'allow'}, {id : '72ef86fa-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createVPC', permission : 'allow'}, {id : '72ef925b-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createVirtualRouterElement', permission : 'allow'}, {id : '72ef9f96-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createVolume', permission : 'allow'}, {id : '72efb7cf-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createVpnConnection', permission : 'allow'}, {id : '72efc432-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createVpnCustomerGateway', permission : 'allow'}, {id : '72efd114-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createVpnGateway', permission : 'allow'}, {id : '72efde25-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteAccount', permission : 'allow'}, {id : '72efeb07-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteAccountFromProject', permission : 'allow'}, {id : '72eff7f1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteAffinityGroup', permission : 'allow'}, {id : '72f0067c-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteAutoScalePolicy', permission : 'allow'}, {id : '72f012e1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteAutoScaleVmGroup', permission : 'allow'}, {id : '72f02139-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteAutoScaleVmProfile', permission : 'allow'}, {id : '72f03128-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteCondition', permission : 'allow'}, {id : '72f03ff1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteDiskOffering', permission : 'allow'}, {id : '72f04e0a-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteEgressFirewallRule', permission : 'allow'}, {id : '72f06242-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteEvents', permission : 'allow'}, {id : '72f0714e-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteFirewallRule', permission : 'allow'}, {id : '72f0815d-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteGlobalLoadBalancerRule', permission : 'allow'}, {id : '72f090aa-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteInstanceGroup', permission : 'allow'}, {id : '72f0a0a1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteIpForwardingRule', permission : 'allow'}, {id : '72f0b030-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteIso', permission : 'allow'}, {id : '72f0bef0-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteLBHealthCheckPolicy', permission : 'allow'}, {id : '72f0cf94-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteLBStickinessPolicy', permission : 'allow'}, {id : '72f0de96-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteLoadBalancer', permission : 'allow'}, {id : '72f2a3ed-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteLoadBalancerRule', permission : 'allow'}, {id : '72f2b9b2-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteNetwork', permission : 'allow'}, {id : '72f2cbdf-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteNetworkACL', permission : 'allow'}, {id : '72f2dd6f-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteNetworkACLList', permission : 'allow'}, {id : '72f2f62a-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deletePortForwardingRule', permission : 'allow'}, {id : '72f301c2-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteProject', permission : 'allow'}, {id : '72f30d74-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteProjectInvitation', permission : 'allow'}, {id : '72f31a33-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteRemoteAccessVpn', permission : 'allow'}, {id : '72f32521-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteSSHKeyPair', permission : 'allow'}, {id : '72f32fe4-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteSecurityGroup', permission : 'allow'}, {id : '72f33b80-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteServiceOffering', permission : 'allow'}, {id : '72f34f1c-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteSnapshot', permission : 'allow'}, {id : '72f35e4c-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteSnapshotPolicies', permission : 'allow'}, {id : '72f36fce-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteSslCert', permission : 'allow'}, {id : '72f37cf2-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteStaticRoute', permission : 'allow'}, {id : '72f38aa1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteTags', permission : 'allow'}, {id : '72f3976e-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteTemplate', permission : 'allow'}, {id : '72f3aa3b-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteUser', permission : 'allow'}, {id : '72f3b857-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteVMSnapshot', permission : 'allow'}, {id : '72f3c65c-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteVPC', permission : 'allow'}, {id : '72f3d1dd-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteVolume', permission : 'allow'}, {id : '72f3de74-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteVpnConnection', permission : 'allow'}, {id : '72f3e9ee-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteVpnCustomerGateway', permission : 'allow'}, {id : '72f3f5cc-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteVpnGateway', permission : 'allow'}, {id : '72f403df-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deployVirtualMachine', permission : 'allow'}, {id : '72f41a8c-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'destroyRouter', permission : 'allow'}, {id : '72f425bb-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'destroyVirtualMachine', permission : 'allow'}, {id : '72f43c34-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'detachIso', permission : 'allow'}, {id : '72f446ba-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'detachVolume', permission : 'allow'}, {id : '72f453c8-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'disableAccount', permission : 'allow'}, {id : '72f461a1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'disableAutoScaleVmGroup', permission : 'allow'}, {id : '72f46d1b-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'disableStaticNat', permission : 'allow'}, {id : '72f47a0d-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'disableUser', permission : 'allow'}, {id : '72f4899f-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'disassociateIpAddress', permission : 'allow'}, {id : '72f4b0d8-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'enableAccount', permission : 'allow'}, {id : '72f4c24a-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'enableAutoScaleVmGroup', permission : 'allow'}, {id : '72f4d201-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'enableStaticNat', permission : 'allow'}, {id : '72f4e7e6-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'enableUser', permission : 'allow'}, {id : '72f505c5-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'expungeVirtualMachine', permission : 'allow'}, {id : '72f5163a-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'extractIso', permission : 'allow'}, {id : '72f52050-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'extractTemplate', permission : 'allow'}, {id : '72f52ca2-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'extractVolume', permission : 'allow'}, {id : '72f53dee-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'getApiLimit', permission : 'allow'}, {id : '72f549ad-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'getCloudIdentifier', permission : 'allow'}, {id : '72f55472-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'getSolidFireAccountId', permission : 'allow'}, {id : '72f55ea7-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'getSolidFireVolumeAccessGroupId', permission : 'allow'}, {id : '72f56762-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'getSolidFireVolumeIscsiName', permission : 'allow'}, {id : '72f570b1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'getSolidFireVolumeSize', permission : 'allow'}, {id : '72f57a42-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'getUploadParamsForTemplate', permission : 'allow'}, {id : '72f584e1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'getUploadParamsForVolume', permission : 'allow'}, {id : '72f58ef5-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'getVMPassword', permission : 'allow'}, {id : '72f59913-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'getVirtualMachineUserData', permission : 'allow'}, {id : '72f5a2d8-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listAccounts', permission : 'allow'}, {id : '72f5aed3-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listAffinityGroupTypes', permission : 'allow'}, {id : '72f5b807-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listAffinityGroups', permission : 'allow'}, {id : '72f5c272-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listApis', permission : 'allow'}, {id : '72f5cbca-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listAsyncJobs', permission : 'allow'}, {id : '72f5d672-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listAutoScalePolicies', permission : 'allow'}, {id : '72f5e513-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listAutoScaleVmGroups', permission : 'allow'}, {id : '72f5f184-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listAutoScaleVmProfiles', permission : 'allow'}, {id : '72f5fd92-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listCapabilities', permission : 'allow'}, {id : '72f60930-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listConditions', permission : 'allow'}, {id : '72f6176e-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listCounters', permission : 'allow'}, {id : '72f622b7-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listDiskOfferings', permission : 'allow'}, {id : '72f62d73-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listDomainChildren', permission : 'allow'}, {id : '72f638d5-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listDomains', permission : 'allow'}, {id : '72f6eea6-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listEgressFirewallRules', permission : 'allow'}, {id : '72f6fac2-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listEventTypes', permission : 'allow'}, {id : '72f703e1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listEvents', permission : 'allow'}, {id : '72f70dcb-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listFirewallRules', permission : 'allow'}, {id : '72f71691-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listGlobalLoadBalancerRules', permission : 'allow'}, {id : '72f71e8c-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listHostTags', permission : 'allow'}, {id : '72f726d2-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listHypervisors', permission : 'allow'}, {id : '72f72f5c-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listInstanceGroups', permission : 'allow'}, {id : '72f738d2-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listInternalLoadBalancerElements', permission : 'allow'}, {id : '72f7411a-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listIpForwardingRules', permission : 'allow'}, {id : '72f74ba4-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listIsoPermissions', permission : 'allow'}, {id : '72f757c8-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listIsos', permission : 'allow'}, {id : '72f766a8-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listLBHealthCheckPolicies', permission : 'allow'}, {id : '72f770a1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listLBStickinessPolicies', permission : 'allow'}, {id : '72f77e34-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listLdapConfigurations', permission : 'allow'}, {id : '72f78763-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listLoadBalancerRuleInstances', permission : 'allow'}, {id : '72f790ae-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listLoadBalancerRules', permission : 'allow'}, {id : '72f799be-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listLoadBalancers', permission : 'allow'}, {id : '72f7d315-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listNetworkACLLists', permission : 'allow'}, {id : '72f7dd1a-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listNetworkACLs', permission : 'allow'}, {id : '72f7e5e4-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listNetworkOfferings', permission : 'allow'}, {id : '72f7ee48-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listNetworks', permission : 'allow'}, {id : '72f7f72b-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listNics', permission : 'allow'}, {id : '72f8005f-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listOsCategories', permission : 'allow'}, {id : '72f80a36-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listOsTypes', permission : 'allow'}, {id : '72f81220-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listOvsElements', permission : 'allow'}, {id : '72f8257f-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listPortForwardingRules', permission : 'allow'}, {id : '72f82d12-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listPrivateGateways', permission : 'allow'}, {id : '72f835f4-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listProjectAccounts', permission : 'allow'}, {id : '72f8452d-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listProjectInvitations', permission : 'allow'}, {id : '72f84f59-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listProjects', permission : 'allow'}, {id : '72f933f8-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listPublicIpAddresses', permission : 'allow'}, {id : '72f94042-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listRegions', permission : 'allow'}, {id : '72f94bc0-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listRemoteAccessVpns', permission : 'allow'}, {id : '72f958d1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listResourceDetails', permission : 'allow'}, {id : '72f963ed-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listResourceLimits', permission : 'allow'}, {id : '72f96ee2-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listRouters', permission : 'allow'}, {id : '72f9784f-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listSSHKeyPairs', permission : 'allow'}, {id : '72f98223-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listSamlAuthorization', permission : 'allow'}, {id : '72f98b62-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listSecurityGroups', permission : 'allow'}, {id : '72f994f1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listServiceOfferings', permission : 'allow'}, {id : '72f9a0e5-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listSnapshotPolicies', permission : 'allow'}, {id : '72f9aca1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listSnapshots', permission : 'allow'}, {id : '72f9b767-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listSslCerts', permission : 'allow'}, {id : '72f9cb8e-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listStaticRoutes', permission : 'allow'}, {id : '72f9d6e4-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listStorageTags', permission : 'allow'}, {id : '72f9e0a8-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listTags', permission : 'allow'}, {id : '72f9eb61-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listTemplatePermissions', permission : 'allow'}, {id : '72f9f83d-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listTemplates', permission : 'allow'}, {id : '72fa019f-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listUsageRecords', permission : 'allow'}, {id : '72fa0a84-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listUsers', permission : 'allow'}, {id : '72fa1231-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listVMSnapshot', permission : 'allow'}, {id : '72fa1e54-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listVPCOfferings', permission : 'allow'}, {id : '72fa2644-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listVPCs', permission : 'allow'}, {id : '72fa2f3c-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listVirtualMachines', permission : 'allow'}, {id : '72fa3753-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listVirtualRouterElements', permission : 'allow'}, {id : '72fa4737-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listVolumes', permission : 'allow'}, {id : '72fa615c-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listVpnConnections', permission : 'allow'}, {id : '72fa6de3-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listVpnCustomerGateways', permission : 'allow'}, {id : '72fa76f6-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listVpnGateways', permission : 'allow'}, {id : '72fa818f-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listVpnUsers', permission : 'allow'}, {id : '72fa8b58-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listZones', permission : 'allow'}, {id : '72fa949d-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'lockAccount', permission : 'allow'}, {id : '72fa9cf0-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'lockUser', permission : 'allow'}, {id : '72fab910-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'queryAsyncJobResult', permission : 'allow'}, {id : '72fac5fc-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'quotaBalance', permission : 'allow'}, {id : '72facec8-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'quotaIsEnabled', permission : 'allow'}, {id : '8cd59791-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'quotaCreditsList', permission : 'allow'}, {id : '93ccdecd-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'quotaResourceStatement', permission : 'allow'}, {id : '72fad800-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'quotaStatement', permission : 'allow'}, {id : '72fae034-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'quotaSummary', permission : 'allow'}, {id : '72fae7c3-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'quotaTariffList', permission : 'allow'}, {id : '72faf0dc-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'rebootRouter', permission : 'allow'}, {id : '72fafae1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'rebootVirtualMachine', permission : 'allow'}, {id : '72fb0b86-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'recoverVirtualMachine', permission : 'allow'}, {id : '72fb1526-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'registerIso', permission : 'allow'}, {id : '72fb1d5d-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'registerSSHKeyPair', permission : 'allow'}, {id : '72fb26d9-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'registerTemplate', permission : 'allow'}, {id : '72fb2fbd-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'registerUserKeys', permission : 'allow'}, {id : '72fb38d0-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'removeCertFromLoadBalancer', permission : 'allow'}, {id : '72fb414a-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'removeFromGlobalLoadBalancerRule', permission : 'allow'}, {id : '72fb4ba0-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'removeFromLoadBalancerRule', permission : 'allow'}, {id : '72fb5a77-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'removeIpFromNic', permission : 'allow'}, {id : '72fb666e-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'removeNicFromVirtualMachine', permission : 'allow'}, {id : '72fb724b-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'removeVpnUser', permission : 'allow'}, {id : '72fb82d8-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'replaceNetworkACLList', permission : 'allow'}, {id : '72fb8efa-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'resetPasswordForVirtualMachine', permission : 'allow'}, {id : '72fb9c51-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'resetSSHKeyForVirtualMachine', permission : 'allow'}, {id : '72fba7a1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'resetVpnConnection', permission : 'allow'}, {id : '72fbb255-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'resizeVolume', permission : 'allow'}, {id : '72fbbe00-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'restartNetwork', permission : 'allow'}, {id : '72fbcaca-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'restartVPC', permission : 'allow'}, {id : '72fbda66-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'restoreVirtualMachine', permission : 'allow'}, {id : '72fbe701-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'revertSnapshot', permission : 'allow'}, {id : '72fbf4f6-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'revertToVMSnapshot', permission : 'allow'}, {id : '72fc2612-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'revokeSecurityGroupEgress', permission : 'allow'}, {id : '72fc3b63-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'revokeSecurityGroupIngress', permission : 'allow'}, {id : '72fc46db-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'scaleVirtualMachine', permission : 'allow'}, {id : '72fc51c1-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'startRouter', permission : 'allow'}, {id : '72fc5bad-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'startVirtualMachine', permission : 'allow'}, {id : '72fc6502-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'stopRouter', permission : 'allow'}, {id : '72fc6dad-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'stopVirtualMachine', permission : 'allow'}, {id : '72fc7846-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'suspendProject', permission : 'allow'}, {id : '72fc7ffe-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateAccount', permission : 'allow'}, {id : '72fc8a7d-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateAutoScalePolicy', permission : 'allow'}, {id : '72fc92e4-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateAutoScaleVmGroup', permission : 'allow'}, {id : '72fc9a67-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateAutoScaleVmProfile', permission : 'allow'}, {id : '72fca361-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateDefaultNicForVirtualMachine', permission : 'allow'}, {id : '72fcad4c-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateDiskOffering', permission : 'allow'}, {id : '72fcb76c-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateEgressFirewallRule', permission : 'allow'}, {id : '72fcc0f3-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateFirewallRule', permission : 'allow'}, {id : '72fcc9d6-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateGlobalLoadBalancerRule', permission : 'allow'}, {id : '72fcd189-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateInstanceGroup', permission : 'allow'}, {id : '72fcdb76-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateIpAddress', permission : 'allow'}, {id : '72fce671-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateIso', permission : 'allow'}, {id : '72fcef37-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateIsoPermissions', permission : 'allow'}, {id : '72fcf6ed-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateLBHealthCheckPolicy', permission : 'allow'}, {id : '72fd0141-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateLBStickinessPolicy', permission : 'allow'}, {id : '72fd0b82-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateLoadBalancer', permission : 'allow'}, {id : '72fd1722-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateLoadBalancerRule', permission : 'allow'}, {id : '72fd20ac-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateNetwork', permission : 'allow'}, {id : '72fd2948-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateNetworkACLItem', permission : 'allow'}, {id : '72fd30f4-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateNetworkACLList', permission : 'allow'}, {id : '72fd3f95-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updatePortForwardingRule', permission : 'allow'}, {id : '72fd4789-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateProject', permission : 'allow'}, {id : '72fd4feb-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateProjectInvitation', permission : 'allow'}, {id : '72fd5917-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateRemoteAccessVpn', permission : 'allow'}, {id : '72fd6388-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateResourceCount', permission : 'allow'}, {id : '72fd6e0b-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateResourceLimit', permission : 'allow'}, {id : '72fe0efd-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateServiceOffering', permission : 'allow'}, {id : '72fe1b59-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateSnapshotPolicy', permission : 'allow'}, {id : '72fe24c9-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateTemplate', permission : 'allow'}, {id : '72fe2e24-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateTemplatePermissions', permission : 'allow'}, {id : '72fe3856-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateUser', permission : 'allow'}, {id : '72fe40a0-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateVMAffinityGroup', permission : 'allow'}, {id : '72fe4a2f-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateVPC', permission : 'allow'}, {id : '72fe5263-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateVirtualMachine', permission : 'allow'}, {id : '72fe5a37-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateVmNicIp', permission : 'allow'}, {id : '72fe6415-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateVpnConnection', permission : 'allow'}, {id : '72fe6db7-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateVpnCustomerGateway', permission : 'allow'}, {id : '72fe7803-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateVpnGateway', permission : 'allow'}, {id : '72fe7f71-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'uploadSslCert', permission : 'allow'}, {id : '72fe87f2-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'uploadVolume', permission : 'allow'}, {id : '7490294c-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'createSnapshotFromVMSnapshot', permission : 'allow'}, {id : '767a595f-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'moveNetworkAclItem', permission : 'allow'}, {id : '7fbaf3b4-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listConfigurations', permission : 'allow'}, {id : '925cfa81-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'deleteUserKeys', permission : 'allow'}, {id : '925e2442-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'listUserKeyRules', permission : 'allow'}, {id : '7fbb0dd7-c3f0-11f1-975d-1e002100023e', roleid : '728abbab-c3f0-11f1-975d-1e002100023e', rolename : 'Domain Admin', rule : 'updateConfiguration', permission : 'allow'}]
2026-10-09 17:14:54,993 - DEBUG - Payload: {'roleid': 4, 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'LMSKVyo3sLvMU8Mn1g0nGOjrQZ0='}
2026-10-09 17:14:54,993 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:14:55,022 - DEBUG - Response : [{id : '72fe8fa8-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'activateProject', permission : 'allow'}, {id : '7cb89fbd-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'addAnnotation', permission : 'allow'}, {id : '7cb856d1-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listAnnotations', permission : 'allow'}, {id : '7cb915ec-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'removeAnnotation', permission : 'allow'}, {id : '72fe9a4d-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'addAccountToProject', permission : 'allow'}, {id : '72fea1f8-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'addIpToNic', permission : 'allow'}, {id : '72feaa12-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'addNicToVirtualMachine', permission : 'allow'}, {id : '72feb1bd-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'addVpnUser', permission : 'allow'}, {id : '72feb92c-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'archiveEvents', permission : 'allow'}, {id : '72fec4ae-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'assignCertToLoadBalancer', permission : 'allow'}, {id : '72fecdd9-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'assignToGlobalLoadBalancerRule', permission : 'allow'}, {id : '72fed753-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'assignToLoadBalancerRule', permission : 'allow'}, {id : '72fee103-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'associateIpAddress', permission : 'allow'}, {id : '72fef31a-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'attachIso', permission : 'allow'}, {id : '72fefc07-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'attachVolume', permission : 'allow'}, {id : '72ff4f55-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'authorizeSecurityGroupEgress', permission : 'allow'}, {id : '72ff9c62-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'authorizeSecurityGroupIngress', permission : 'allow'}, {id : '72ffc37b-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'changeServiceForVirtualMachine', permission : 'allow'}, {id : '72ffcef4-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'copyIso', permission : 'allow'}, {id : '72ffd9b9-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'copyTemplate', permission : 'allow'}, {id : '72ffe4c4-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createAffinityGroup', permission : 'allow'}, {id : '72ffef38-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createAutoScalePolicy', permission : 'allow'}, {id : '72fff970-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createAutoScaleVmGroup', permission : 'allow'}, {id : '7300050a-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createAutoScaleVmProfile', permission : 'allow'}, {id : '73001075-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createCondition', permission : 'allow'}, {id : '73001ac6-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createEgressFirewallRule', permission : 'allow'}, {id : '730024ef-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createFirewallRule', permission : 'allow'}, {id : '73002fd7-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createGlobalLoadBalancerRule', permission : 'allow'}, {id : '73003a6d-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createInstanceGroup', permission : 'allow'}, {id : '730044e3-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createIpForwardingRule', permission : 'allow'}, {id : '73004ee8-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createLBHealthCheckPolicy', permission : 'allow'}, {id : '73005979-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createLBStickinessPolicy', permission : 'allow'}, {id : '730063c5-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createLoadBalancer', permission : 'allow'}, {id : '730142c5-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createLoadBalancerRule', permission : 'allow'}, {id : '73015e7f-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createNetwork', permission : 'allow'}, {id : '73016ab6-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createNetworkACL', permission : 'allow'}, {id : '73017698-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createNetworkACLList', permission : 'allow'}, {id : '73018c9b-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createPortForwardingRule', permission : 'allow'}, {id : '730197d3-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createProject', permission : 'allow'}, {id : '7301a1f8-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createRemoteAccessVpn', permission : 'allow'}, {id : '7301ac19-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createSSHKeyPair', permission : 'allow'}, {id : '7301b9da-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createSecurityGroup', permission : 'allow'}, {id : '7301c4ed-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createSnapshot', permission : 'allow'}, {id : '7301cfc8-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createSnapshotPolicy', permission : 'allow'}, {id : '7301d9cc-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createStaticRoute', permission : 'allow'}, {id : '7301e506-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createTags', permission : 'allow'}, {id : '7301ef1d-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createTemplate', permission : 'allow'}, {id : '7301f9a1-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createVMSnapshot', permission : 'allow'}, {id : '7302045b-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createVPC', permission : 'allow'}, {id : '73020ecd-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createVolume', permission : 'allow'}, {id : '730222fa-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createVpnConnection', permission : 'allow'}, {id : '73022de0-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createVpnCustomerGateway', permission : 'allow'}, {id : '730238dd-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createVpnGateway', permission : 'allow'}, {id : '7302434c-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteAccountFromProject', permission : 'allow'}, {id : '73024d4d-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteAffinityGroup', permission : 'allow'}, {id : '7302583a-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteAutoScalePolicy', permission : 'allow'}, {id : '7302624c-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteAutoScaleVmGroup', permission : 'allow'}, {id : '73026c8d-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteAutoScaleVmProfile', permission : 'allow'}, {id : '730276bc-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteCondition', permission : 'allow'}, {id : '73028447-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteEgressFirewallRule', permission : 'allow'}, {id : '73028eb8-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteEvents', permission : 'allow'}, {id : '7302ab5f-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteFirewallRule', permission : 'allow'}, {id : '7302bada-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteGlobalLoadBalancerRule', permission : 'allow'}, {id : '7302c84b-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteInstanceGroup', permission : 'allow'}, {id : '7302d584-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteIpForwardingRule', permission : 'allow'}, {id : '7302e07d-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteIso', permission : 'allow'}, {id : '7302eb25-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteLBHealthCheckPolicy', permission : 'allow'}, {id : '7302f883-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteLBStickinessPolicy', permission : 'allow'}, {id : '730304b0-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteLoadBalancer', permission : 'allow'}, {id : '73030f73-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteLoadBalancerRule', permission : 'allow'}, {id : '73031b46-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteNetwork', permission : 'allow'}, {id : '7303266c-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteNetworkACL', permission : 'allow'}, {id : '730331f1-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteNetworkACLList', permission : 'allow'}, {id : '73034bca-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deletePortForwardingRule', permission : 'allow'}, {id : '7303575d-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteProject', permission : 'allow'}, {id : '73036187-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteProjectInvitation', permission : 'allow'}, {id : '73036d27-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteRemoteAccessVpn', permission : 'allow'}, {id : '73037805-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteSSHKeyPair', permission : 'allow'}, {id : '7303828d-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteSecurityGroup', permission : 'allow'}, {id : '73038db7-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteSnapshot', permission : 'allow'}, {id : '7303986b-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteSnapshotPolicies', permission : 'allow'}, {id : '7303a36d-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteSslCert', permission : 'allow'}, {id : '7303aee7-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteStaticRoute', permission : 'allow'}, {id : '7303ba9e-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteTags', permission : 'allow'}, {id : '7303c74e-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteTemplate', permission : 'allow'}, {id : '7303d31f-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteVMSnapshot', permission : 'allow'}, {id : '7303de61-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteVPC', permission : 'allow'}, {id : '7303eb4d-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteVolume', permission : 'allow'}, {id : '7303f672-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteVpnConnection', permission : 'allow'}, {id : '7304041b-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteVpnCustomerGateway', permission : 'allow'}, {id : '73040f2e-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteVpnGateway', permission : 'allow'}, {id : '73041d08-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deployVirtualMachine', permission : 'allow'}, {id : '7304334b-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'destroyVirtualMachine', permission : 'allow'}, {id : '73044959-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'detachIso', permission : 'allow'}, {id : '73045443-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'detachVolume', permission : 'allow'}, {id : '73045e8d-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'disableAutoScaleVmGroup', permission : 'allow'}, {id : '7304689e-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'disableStaticNat', permission : 'allow'}, {id : '73047354-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'disassociateIpAddress', permission : 'allow'}, {id : '73048ad1-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'enableAutoScaleVmGroup', permission : 'allow'}, {id : '73049777-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'enableStaticNat', permission : 'allow'}, {id : '7304a314-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'expungeVirtualMachine', permission : 'allow'}, {id : '7304ae7c-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'extractIso', permission : 'allow'}, {id : '7304b8d0-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'extractTemplate', permission : 'allow'}, {id : '7304c3da-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'extractVolume', permission : 'allow'}, {id : '7304ce2b-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'getApiLimit', permission : 'allow'}, {id : '7304d962-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'getCloudIdentifier', permission : 'allow'}, {id : '7304e442-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'getSolidFireAccountId', permission : 'allow'}, {id : '7304ef64-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'getSolidFireVolumeAccessGroupId', permission : 'allow'}, {id : '7304f978-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'getSolidFireVolumeIscsiName', permission : 'allow'}, {id : '730503ad-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'getSolidFireVolumeSize', permission : 'allow'}, {id : '73050efb-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'getUploadParamsForTemplate', permission : 'allow'}, {id : '730519f0-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'getUploadParamsForVolume', permission : 'allow'}, {id : '7305264f-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'getVMPassword', permission : 'allow'}, {id : '730530ba-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'getVirtualMachineUserData', permission : 'allow'}, {id : '73053b6e-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listAccounts', permission : 'allow'}, {id : '730545d2-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listAffinityGroupTypes', permission : 'allow'}, {id : '73054fec-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listAffinityGroups', permission : 'allow'}, {id : '73055a11-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listApis', permission : 'allow'}, {id : '73056826-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listAsyncJobs', permission : 'allow'}, {id : '73057389-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listAutoScalePolicies', permission : 'allow'}, {id : '7305804f-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listAutoScaleVmGroups', permission : 'allow'}, {id : '73058d2c-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listAutoScaleVmProfiles', permission : 'allow'}, {id : '730597ee-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listCapabilities', permission : 'allow'}, {id : '7305a3a5-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listConditions', permission : 'allow'}, {id : '7305afad-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listCounters', permission : 'allow'}, {id : '7305beb8-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listDiskOfferings', permission : 'allow'}, {id : '7305cc06-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listEgressFirewallRules', permission : 'allow'}, {id : '7305dd0f-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listEventTypes', permission : 'allow'}, {id : '7305e95c-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listEvents', permission : 'allow'}, {id : '7305f61f-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listFirewallRules', permission : 'allow'}, {id : '7306029a-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listGlobalLoadBalancerRules', permission : 'allow'}, {id : '73060d45-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listHypervisors', permission : 'allow'}, {id : '73087a77-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listInstanceGroups', permission : 'allow'}, {id : '73089767-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listIpForwardingRules', permission : 'allow'}, {id : '7308a84a-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listIsoPermissions', permission : 'allow'}, {id : '7308b66a-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listIsos', permission : 'allow'}, {id : '7308c2ac-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listLBHealthCheckPolicies', permission : 'allow'}, {id : '7308ce27-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listLBStickinessPolicies', permission : 'allow'}, {id : '7308d8e4-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listLdapConfigurations', permission : 'allow'}, {id : '7308e44a-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listLoadBalancerRuleInstances', permission : 'allow'}, {id : '7308eecc-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listLoadBalancerRules', permission : 'allow'}, {id : '7308f8c3-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listLoadBalancers', permission : 'allow'}, {id : '73090fef-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listNetworkACLLists', permission : 'allow'}, {id : '73091b6c-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listNetworkACLs', permission : 'allow'}, {id : '73092847-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listNetworkOfferings', permission : 'allow'}, {id : '730934fe-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listNetworks', permission : 'allow'}, {id : '730940be-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listNics', permission : 'allow'}, {id : '73094b76-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listOsCategories', permission : 'allow'}, {id : '730956c4-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listOsTypes', permission : 'allow'}, {id : '73096d3f-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listPortForwardingRules', permission : 'allow'}, {id : '730977bf-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listPrivateGateways', permission : 'allow'}, {id : '7309825b-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listProjectAccounts', permission : 'allow'}, {id : '73098cb5-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listProjectInvitations', permission : 'allow'}, {id : '730996b7-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listProjects', permission : 'allow'}, {id : '7309a1bf-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listPublicIpAddresses', permission : 'allow'}, {id : '7309afa9-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listRegions', permission : 'allow'}, {id : '7309bc77-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listRemoteAccessVpns', permission : 'allow'}, {id : '7309c7f9-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listResourceDetails', permission : 'allow'}, {id : '7309d6dc-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listResourceLimits', permission : 'allow'}, {id : '7309e2e0-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listSSHKeyPairs', permission : 'allow'}, {id : '7309ed4e-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listSecurityGroups', permission : 'allow'}, {id : '7309fb21-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listServiceOfferings', permission : 'allow'}, {id : '730ab539-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listSnapshotPolicies', permission : 'allow'}, {id : '730ac6d0-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listSnapshots', permission : 'allow'}, {id : '730ad2f4-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listSslCerts', permission : 'allow'}, {id : '730ade2f-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listStaticRoutes', permission : 'allow'}, {id : '730ae993-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listTags', permission : 'allow'}, {id : '730af54e-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listTemplatePermissions', permission : 'allow'}, {id : '730c0f3b-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listTemplates', permission : 'allow'}, {id : '730c200e-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listUsers', permission : 'allow'}, {id : '730c2b9d-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listVMSnapshot', permission : 'allow'}, {id : '730c3701-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listVPCOfferings', permission : 'allow'}, {id : '730c42f5-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listVPCs', permission : 'allow'}, {id : '730c4de0-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listVirtualMachines', permission : 'allow'}, {id : '730c5973-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listVolumes', permission : 'allow'}, {id : '730c75f5-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listVpnConnections', permission : 'allow'}, {id : '730c8134-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listVpnCustomerGateways', permission : 'allow'}, {id : '730c901d-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listVpnGateways', permission : 'allow'}, {id : '730c9eea-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listVpnUsers', permission : 'allow'}, {id : '730cad1b-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listZones', permission : 'allow'}, {id : '730cdcc6-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'queryAsyncJobResult', permission : 'allow'}, {id : '730ceb1a-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'quotaBalance', permission : 'allow'}, {id : '730cf865-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'quotaIsEnabled', permission : 'allow'}, {id : '8cd59b9e-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'quotaCreditsList', permission : 'allow'}, {id : '93cce2cd-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'quotaResourceStatement', permission : 'allow'}, {id : '730d0584-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'quotaStatement', permission : 'allow'}, {id : '730d1395-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'quotaSummary', permission : 'allow'}, {id : '730d20eb-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'quotaTariffList', permission : 'allow'}, {id : '730d2ec3-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'rebootVirtualMachine', permission : 'allow'}, {id : '730d3da0-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'recoverVirtualMachine', permission : 'allow'}, {id : '730d4ccf-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'registerIso', permission : 'allow'}, {id : '730d5d27-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'registerSSHKeyPair', permission : 'allow'}, {id : '730d6c75-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'registerTemplate', permission : 'allow'}, {id : '730d7d3a-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'registerUserKeys', permission : 'allow'}, {id : '730d8905-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'removeCertFromLoadBalancer', permission : 'allow'}, {id : '730d955e-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'removeFromGlobalLoadBalancerRule', permission : 'allow'}, {id : '730da11d-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'removeFromLoadBalancerRule', permission : 'allow'}, {id : '730dcae4-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'removeIpFromNic', permission : 'allow'}, {id : '730dda13-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'removeNicFromVirtualMachine', permission : 'allow'}, {id : '730de8e8-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'removeVpnUser', permission : 'allow'}, {id : '730dfb4d-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'replaceNetworkACLList', permission : 'allow'}, {id : '730e0981-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'resetPasswordForVirtualMachine', permission : 'allow'}, {id : '730e18a0-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'resetSSHKeyForVirtualMachine', permission : 'allow'}, {id : '730e24e8-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'resetVpnConnection', permission : 'allow'}, {id : '730e2f67-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'resizeVolume', permission : 'allow'}, {id : '730e3b77-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'restartNetwork', permission : 'allow'}, {id : '730e469b-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'restartVPC', permission : 'allow'}, {id : '730e5171-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'restoreVirtualMachine', permission : 'allow'}, {id : '730e5bb5-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'revertSnapshot', permission : 'allow'}, {id : '730e6662-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'revertToVMSnapshot', permission : 'allow'}, {id : '730ede83-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'revokeSecurityGroupEgress', permission : 'allow'}, {id : '730ef2ba-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'revokeSecurityGroupIngress', permission : 'allow'}, {id : '730effd2-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'scaleVirtualMachine', permission : 'allow'}, {id : '730f0afb-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'startVirtualMachine', permission : 'allow'}, {id : '730f16c6-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'stopVirtualMachine', permission : 'allow'}, {id : '730f21ae-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'suspendProject', permission : 'allow'}, {id : '730f2cf0-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateAutoScalePolicy', permission : 'allow'}, {id : '730f3759-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateAutoScaleVmGroup', permission : 'allow'}, {id : '730f42c9-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateAutoScaleVmProfile', permission : 'allow'}, {id : '730f51c1-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateDefaultNicForVirtualMachine', permission : 'allow'}, {id : '730f5fd9-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateEgressFirewallRule', permission : 'allow'}, {id : '730f7263-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateFirewallRule', permission : 'allow'}, {id : '730f8745-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateGlobalLoadBalancerRule', permission : 'allow'}, {id : '730f93fc-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateInstanceGroup', permission : 'allow'}, {id : '730fa095-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateIpAddress', permission : 'allow'}, {id : '730fb177-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateIso', permission : 'allow'}, {id : '730fc017-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateIsoPermissions', permission : 'allow'}, {id : '730fd195-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateLBHealthCheckPolicy', permission : 'allow'}, {id : '730fe0e2-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateLBStickinessPolicy', permission : 'allow'}, {id : '730fede9-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateLoadBalancer', permission : 'allow'}, {id : '730fff84-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateLoadBalancerRule', permission : 'allow'}, {id : '73101012-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateNetwork', permission : 'allow'}, {id : '73101e5b-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateNetworkACLItem', permission : 'allow'}, {id : '73102d1a-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateNetworkACLList', permission : 'allow'}, {id : '731039d6-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updatePortForwardingRule', permission : 'allow'}, {id : '7310479f-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateProject', permission : 'allow'}, {id : '73105431-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateProjectInvitation', permission : 'allow'}, {id : '73106471-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateRemoteAccessVpn', permission : 'allow'}, {id : '7310730b-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateSnapshotPolicy', permission : 'allow'}, {id : '73107f98-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateTemplate', permission : 'allow'}, {id : '73108f80-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateTemplatePermissions', permission : 'allow'}, {id : '73109ef5-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateUser', permission : 'allow'}, {id : '7310ade8-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateVMAffinityGroup', permission : 'allow'}, {id : '7310b989-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateVPC', permission : 'allow'}, {id : '7310c5bd-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateVirtualMachine', permission : 'allow'}, {id : '7310d204-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateVmNicIp', permission : 'allow'}, {id : '7310e122-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateVpnConnection', permission : 'allow'}, {id : '7310efa1-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateVpnCustomerGateway', permission : 'allow'}, {id : '7310fcfc-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'updateVpnGateway', permission : 'allow'}, {id : '73110800-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'uploadSslCert', permission : 'allow'}, {id : '731114f0-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'uploadVolume', permission : 'allow'}, {id : '925ca193-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'deleteUserKeys', permission : 'allow'}, {id : '925dc74f-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'listUserKeyRules', permission : 'allow'}, {id : '7490b059-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'createSnapshotFromVMSnapshot', permission : 'allow'}, {id : '767a6a64-c3f0-11f1-975d-1e002100023e', roleid : '728acd28-c3f0-11f1-975d-1e002100023e', rolename : 'User', rule : 'moveNetworkAclItem', permission : 'allow'}]
2026-10-09 17:14:55,023 - DEBUG - Payload: {'id': 'e6f8f335-05dd-4d06-b35c-108343255705', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'WQuXy8VvU5EZRs0Qe/Z7JMF1aT4='}
2026-10-09 17:14:55,023 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:55,080 - DEBUG - === Jobid: b36b2267-a46e-4bba-98b0-d65242cbed14 Started ===
2026-10-09 17:14:55,080 - DEBUG - Payload: {'jobid': 'b36b2267-a46e-4bba-98b0-d65242cbed14', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'7vxA3tSc1cdoKQdUokyrXe0HA1U='}
2026-10-09 17:14:55,080 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:55,109 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'e6f8f335-05dd-4d06-b35c-108343255705', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:55+0000', jobid : 'b36b2267-a46e-4bba-98b0-d65242cbed14', jobstatus : 0}
2026-10-09 17:14:56,111 - DEBUG - === JobId:b36b2267-a46e-4bba-98b0-d65242cbed14 is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:56,111 - DEBUG - Payload: {'jobid': 'b36b2267-a46e-4bba-98b0-d65242cbed14', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'7vxA3tSc1cdoKQdUokyrXe0HA1U='}
2026-10-09 17:14:56,111 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:56,144 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'e6f8f335-05dd-4d06-b35c-108343255705', created : '2026-10-09T17:14:55+0000', completed : '2026-10-09T17:14:55+0000', jobid : 'b36b2267-a46e-4bba-98b0-d65242cbed14', jobstatus : 1}
2026-10-09 17:14:56,144 - DEBUG - ===Jobid:b36b2267-a46e-4bba-98b0-d65242cbed14 ; StartTime:Fri Oct  9 17:14:55 2026 ; EndTime:Fri Oct  9 17:14:56 2026 ; TotalTime:-1===
2026-10-09 17:14:56,144 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'e6f8f335-05dd-4d06-b35c-108343255705', created : '2026-10-09T17:14:55+0000', completed : '2026-10-09T17:14:55+0000', jobid : 'b36b2267-a46e-4bba-98b0-d65242cbed14', jobstatus : 1}
2026-10-09 17:14:56,145 - DEBUG - Payload: {'id': '3c5ca02a-3c7d-48e9-85a3-3b44da640074', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'CLXvWWdBB0RwjxiEqBxHE7hCOKE='}
2026-10-09 17:14:56,145 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:56,189 - DEBUG - Response : {success : True}
2026-10-09 17:14:56,189 - DEBUG - Payload: {'id': 'a46d87eb-4eec-4c0b-8369-2f4c58d67566', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'NarH3FM8XXfVtPW+AFSOwsSVjOI='}
2026-10-09 17:14:56,189 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:56,231 - DEBUG - Response : {success : True}
2026-10-09 17:14:56,231 - DEBUG - TestCaseName: test_rolepermission_lifecycle_list; Time Taken: 2 Seconds; StartTime: Fri Oct  9 17:14:53 2026; EndTime: Fri Oct  9 17:14:56 2026; Result: SUCCESS
2026-10-09 17:14:56,232 - DEBUG - ::::::::::::STARTED : TC: test_rolepermission_lifecycle_update :::::::::::
2026-10-09 17:14:56,232 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:56,232 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:56,276 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:56,277 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role es9cvkm0is', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'03+6d/pqGf6klqTNcw+kOhOH5ls='}
2026-10-09 17:14:56,277 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:56,319 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', name : 'MarvinFake Role es9cvkm0is', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:56,319 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'B9ehaT+ZZh3mmmAeiOS7AseJVPw='}
2026-10-09 17:14:56,319 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:56,362 - DEBUG - Response : {id : 'bae42ece-721c-4c30-8f76-63816a7eea34', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:56,363 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'username': 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update-VO8OSN', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'8eeIJaadPTGbFDTxRIxPUg+zwWg='}
2026-10-09 17:14:56,363 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:14:57,845 - DEBUG - Response : {id : '7e7e37c4-475b-4ecc-b05e-754047983b5a', name : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update-VO8OSN', accounttype : 0, roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', roletype : 'User', rolename : 'MarvinFake Role es9cvkm0is', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:14:57+0000', user : [{id : 'd3f439e5-9f02-4413-88c4-12db08f0da85', username : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update-VO8OSN', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:14:57+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update-VO8OSN', accounttype : 0, usersource : 'native', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', roletype : 'User', rolename : 'MarvinFake Role es9cvkm0is', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '7e7e37c4-475b-4ecc-b05e-754047983b5a', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:14:57,845 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:14:57,845 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:14:57,878 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:14:57,879 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'rule': 'list*', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'nrvLaFVci4dzAaHj9tv/3qZKksA='}
2026-10-09 17:14:57,879 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:57,916 - DEBUG - Response : {id : '5845d97a-814e-4e86-8c86-679f9d99d15e', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rule : 'list*', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:57,917 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'rule': '*Vol*', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'lrNGF1L8aEiRUQNt11Mc8Fwwb5c='}
2026-10-09 17:14:57,917 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:57,960 - DEBUG - Response : {id : '179768eb-6614-491f-80f9-b5339c4c03a8', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rule : '*Vol*', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:57,960 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'rule': 'listCapabilities', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'06aahIKq79OgEOm2Qa8S6bEA02Q='}
2026-10-09 17:14:57,960 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:58,018 - DEBUG - Response : {id : '634f0b0c-b4a3-43b7-86a0-2ed0f2965853', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rule : 'listCapabilities', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:58,018 - DEBUG - Payload: {'roleid': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'ruleorder': '634f0b0c-b4a3-43b7-86a0-2ed0f2965853,bae42ece-721c-4c30-8f76-63816a7eea34,5845d97a-814e-4e86-8c86-679f9d99d15e,179768eb-6614-491f-80f9-b5339c4c03a8', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'aqnmXbrD6qKBqHOOza27wYKUwCg='}
2026-10-09 17:14:58,018 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-09 17:14:58,071 - DEBUG - Response : {success : True}
2026-10-09 17:14:58,071 - DEBUG - Payload: {'roleid': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'lGjaJ1AuS+ctrW+awBeZB+o0cfY='}
2026-10-09 17:14:58,071 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:14:58,094 - DEBUG - Response : [{id : '634f0b0c-b4a3-43b7-86a0-2ed0f2965853', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : 'listCapabilities', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : 'bae42ece-721c-4c30-8f76-63816a7eea34', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '5845d97a-814e-4e86-8c86-679f9d99d15e', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : 'list*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '179768eb-6614-491f-80f9-b5339c4c03a8', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : '*Vol*', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-09 17:14:58,095 - DEBUG - Payload: {'roleid': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'ruleorder': 'bae42ece-721c-4c30-8f76-63816a7eea34,5845d97a-814e-4e86-8c86-679f9d99d15e,179768eb-6614-491f-80f9-b5339c4c03a8,634f0b0c-b4a3-43b7-86a0-2ed0f2965853', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'79qVM5b0iqEJ4dRuGvxjhTOyvvc='}
2026-10-09 17:14:58,095 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-09 17:14:58,134 - DEBUG - Response : {success : True}
2026-10-09 17:14:58,134 - DEBUG - Payload: {'roleid': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'lGjaJ1AuS+ctrW+awBeZB+o0cfY='}
2026-10-09 17:14:58,134 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:14:58,153 - DEBUG - Response : [{id : 'bae42ece-721c-4c30-8f76-63816a7eea34', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '5845d97a-814e-4e86-8c86-679f9d99d15e', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : 'list*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '179768eb-6614-491f-80f9-b5339c4c03a8', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : '*Vol*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '634f0b0c-b4a3-43b7-86a0-2ed0f2965853', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : 'listCapabilities', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-09 17:14:58,153 - DEBUG - Payload: {'roleid': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'ruleorder': '634f0b0c-b4a3-43b7-86a0-2ed0f2965853,5845d97a-814e-4e86-8c86-679f9d99d15e,bae42ece-721c-4c30-8f76-63816a7eea34,179768eb-6614-491f-80f9-b5339c4c03a8', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'exmhpht3kFTWmI1drI6tnyyXUqI='}
2026-10-09 17:14:58,154 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-09 17:14:58,189 - DEBUG - Response : {success : True}
2026-10-09 17:14:58,189 - DEBUG - Payload: {'roleid': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'lGjaJ1AuS+ctrW+awBeZB+o0cfY='}
2026-10-09 17:14:58,189 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:14:58,210 - DEBUG - Response : [{id : '634f0b0c-b4a3-43b7-86a0-2ed0f2965853', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : 'listCapabilities', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '5845d97a-814e-4e86-8c86-679f9d99d15e', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : 'list*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : 'bae42ece-721c-4c30-8f76-63816a7eea34', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '179768eb-6614-491f-80f9-b5339c4c03a8', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : '*Vol*', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-09 17:14:58,211 - DEBUG - Payload: {'roleid': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'ruleorder': '5845d97a-814e-4e86-8c86-679f9d99d15e,179768eb-6614-491f-80f9-b5339c4c03a8,bae42ece-721c-4c30-8f76-63816a7eea34,634f0b0c-b4a3-43b7-86a0-2ed0f2965853', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'YEDbhg6Gl850mtTFDJKlatgM1Ug='}
2026-10-09 17:14:58,211 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-09 17:14:58,251 - DEBUG - Response : {success : True}
2026-10-09 17:14:58,252 - DEBUG - Payload: {'roleid': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'lGjaJ1AuS+ctrW+awBeZB+o0cfY='}
2026-10-09 17:14:58,252 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:14:58,275 - DEBUG - Response : [{id : '5845d97a-814e-4e86-8c86-679f9d99d15e', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : 'list*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '179768eb-6614-491f-80f9-b5339c4c03a8', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : '*Vol*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : 'bae42ece-721c-4c30-8f76-63816a7eea34', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '634f0b0c-b4a3-43b7-86a0-2ed0f2965853', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : 'listCapabilities', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-09 17:14:58,275 - DEBUG - Payload: {'roleid': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'ruleorder': '634f0b0c-b4a3-43b7-86a0-2ed0f2965853,5845d97a-814e-4e86-8c86-679f9d99d15e,179768eb-6614-491f-80f9-b5339c4c03a8,bae42ece-721c-4c30-8f76-63816a7eea34', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'C5Mzg8KSLT6/+Kc4DvSPpQz8LXo='}
2026-10-09 17:14:58,275 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-09 17:14:58,322 - DEBUG - Response : {success : True}
2026-10-09 17:14:58,323 - DEBUG - Payload: {'roleid': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'lGjaJ1AuS+ctrW+awBeZB+o0cfY='}
2026-10-09 17:14:58,323 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:14:58,347 - DEBUG - Response : [{id : '634f0b0c-b4a3-43b7-86a0-2ed0f2965853', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : 'listCapabilities', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '5845d97a-814e-4e86-8c86-679f9d99d15e', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : 'list*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '179768eb-6614-491f-80f9-b5339c4c03a8', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : '*Vol*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : 'bae42ece-721c-4c30-8f76-63816a7eea34', roleid : 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', rolename : 'MarvinFake Role es9cvkm0is', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-09 17:14:58,348 - DEBUG - Payload: {'id': '7e7e37c4-475b-4ecc-b05e-754047983b5a', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'cvB1da5Gp9PZfEtkU2bCKsBX3Cc='}
2026-10-09 17:14:58,348 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:14:58,396 - DEBUG - === Jobid: 84d7e031-ed27-439a-ab08-f465e5a6f400 Started ===
2026-10-09 17:14:58,396 - DEBUG - Payload: {'jobid': '84d7e031-ed27-439a-ab08-f465e5a6f400', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'pay8nejREv8PaXomQrqFE6r1mp8='}
2026-10-09 17:14:58,396 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:58,428 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '7e7e37c4-475b-4ecc-b05e-754047983b5a', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:14:58+0000', jobid : '84d7e031-ed27-439a-ab08-f465e5a6f400', jobstatus : 0}
2026-10-09 17:14:59,429 - DEBUG - === JobId:84d7e031-ed27-439a-ab08-f465e5a6f400 is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:14:59,430 - DEBUG - Payload: {'jobid': '84d7e031-ed27-439a-ab08-f465e5a6f400', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'pay8nejREv8PaXomQrqFE6r1mp8='}
2026-10-09 17:14:59,430 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:14:59,465 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '7e7e37c4-475b-4ecc-b05e-754047983b5a', created : '2026-10-09T17:14:58+0000', completed : '2026-10-09T17:14:58+0000', jobid : '84d7e031-ed27-439a-ab08-f465e5a6f400', jobstatus : 1}
2026-10-09 17:14:59,465 - DEBUG - ===Jobid:84d7e031-ed27-439a-ab08-f465e5a6f400 ; StartTime:Fri Oct  9 17:14:58 2026 ; EndTime:Fri Oct  9 17:14:59 2026 ; TotalTime:-1===
2026-10-09 17:14:59,466 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '7e7e37c4-475b-4ecc-b05e-754047983b5a', created : '2026-10-09T17:14:58+0000', completed : '2026-10-09T17:14:58+0000', jobid : '84d7e031-ed27-439a-ab08-f465e5a6f400', jobstatus : 1}
2026-10-09 17:14:59,466 - DEBUG - Payload: {'id': 'bae42ece-721c-4c30-8f76-63816a7eea34', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'02o2WrRYVnm1MZpWZwdFardeyP8='}
2026-10-09 17:14:59,466 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:59,502 - DEBUG - Response : {success : True}
2026-10-09 17:14:59,503 - DEBUG - Payload: {'id': 'ea49ab6d-08ff-417c-a5f9-45bf2a828533', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'RuCpVNXb5FyymXpqUrRg5FF4EfE='}
2026-10-09 17:14:59,503 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:14:59,540 - DEBUG - Response : {success : True}
2026-10-09 17:14:59,540 - DEBUG - Payload: {'id': '5845d97a-814e-4e86-8c86-679f9d99d15e', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Yg9FWppvCkOvwWQZsv43G+1Ae+c='}
2026-10-09 17:14:59,540 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:14:59,560 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterolepermission failed, due to: errorCode: 431, errorText:Unable to execute API command deleterolepermission due to invalid value. Invalid parameter id value=5845d97a-814e-4e86-8c86-679f9d99d15e due to incorrect long value format, or entity does not exist or due to incorrect parameter annotation for the field in api cmd class.\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterolepermission failed, due to: errorCode: 431, errorText:Unable to execute API command deleterolepermission due to invalid value. Invalid parameter id value=5845d97a-814e-4e86-8c86-679f9d99d15e due to incorrect long value format, or entity does not exist or due to incorrect parameter annotation for the field in api cmd class.
2026-10-09 17:14:59,561 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRolePermission.deleteRolePermissionCmd object at 0x7f22470d6100> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterolepermission failed, due to: errorCode: 431, errorText:Unable to execute API command deleterolepermission due to invalid value. Invalid parameter id value=5845d97a-814e-4e86-8c86-679f9d99d15e due to incorrect long value format, or entity does not exist or due to incorrect parameter annotation for the field in api cmd class.\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: deleterolepermission failed, due to: errorCode: 431, errorText:Unable to execute API command deleterolepermission due to invalid value. Invalid parameter id value=5845d97a-814e-4e86-8c86-679f9d99d15e due to incorrect long value format, or entity does not exist or due to incorrect parameter annotation for the field in api cmd class.
2026-10-09 17:14:59,561 - DEBUG - Warning! Exception in tearDown: Execute cmd: deleterolepermission failed, due to: errorCode: 431, errorText:Unable to execute API command deleterolepermission due to invalid value. Invalid parameter id value=5845d97a-814e-4e86-8c86-679f9d99d15e due to incorrect long value format, or entity does not exist or due to incorrect parameter annotation for the field in api cmd class.
2026-10-09 17:14:59,561 - DEBUG - TestCaseName: test_rolepermission_lifecycle_update; Time Taken: 3 Seconds; StartTime: Fri Oct  9 17:14:56 2026; EndTime: Fri Oct  9 17:14:59 2026; Result: SUCCESS
2026-10-09 17:14:59,561 - DEBUG - ::::::::::::STARTED : TC: test_rolepermission_lifecycle_update_permission :::::::::::
2026-10-09 17:14:59,561 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:14:59,562 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:14:59,602 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:14:59,603 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role uac210g5h4', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'E4VSMQooRm6ZfFs2D9iDnis6G+k='}
2026-10-09 17:14:59,603 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:14:59,638 - DEBUG - Response : {type : 'User', state : 'enabled', id : '32a9a765-3d01-4c99-ada1-331c023d2b0d', name : 'MarvinFake Role uac210g5h4', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:14:59,638 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '32a9a765-3d01-4c99-ada1-331c023d2b0d', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'uhh0eqybkw52iS+U0woTBxmeZF8='}
2026-10-09 17:14:59,638 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:14:59,679 - DEBUG - Response : {id : '57a86e42-949e-48ef-aa7b-80c6f04f5254', roleid : '32a9a765-3d01-4c99-ada1-331c023d2b0d', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:14:59,679 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '32a9a765-3d01-4c99-ada1-331c023d2b0d', 'username': 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission-FS16BE', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'SmMay9PH/BdbtXdznj6bDJ19iwo='}
2026-10-09 17:14:59,679 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:15:01,107 - DEBUG - Response : {id : '339ba0ac-87c4-4980-839f-ffe0c5cc0bba', name : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission-FS16BE', accounttype : 0, roleid : '32a9a765-3d01-4c99-ada1-331c023d2b0d', roletype : 'User', rolename : 'MarvinFake Role uac210g5h4', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:15:00+0000', user : [{id : 'f7c7a560-361d-4f47-92d0-175e1929d16b', username : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission-FS16BE', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:15:01+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission-FS16BE', accounttype : 0, usersource : 'native', roleid : '32a9a765-3d01-4c99-ada1-331c023d2b0d', roletype : 'User', rolename : 'MarvinFake Role uac210g5h4', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '339ba0ac-87c4-4980-839f-ffe0c5cc0bba', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:15:01,107 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:15:01,107 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:15:01,139 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:15:01,140 - DEBUG - Payload: {'permission': 'deny', 'roleid': '32a9a765-3d01-4c99-ada1-331c023d2b0d', 'ruleid': '57a86e42-949e-48ef-aa7b-80c6f04f5254', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'WJqJsvi5zIR1kQ13cw0n0yuht4E='}
2026-10-09 17:15:01,140 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-09 17:15:01,177 - DEBUG - Response : {success : True}
2026-10-09 17:15:01,178 - DEBUG - Payload: {'roleid': '32a9a765-3d01-4c99-ada1-331c023d2b0d', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'I6qku6Xp004mg+uGx8dnLq0pOPs='}
2026-10-09 17:15:01,178 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:15:01,204 - DEBUG - Response : [{id : '57a86e42-949e-48ef-aa7b-80c6f04f5254', roleid : '32a9a765-3d01-4c99-ada1-331c023d2b0d', rolename : 'MarvinFake Role uac210g5h4', rule : 'listVirtualMachines', permission : 'deny', description : 'Fake role permission created by Marvin test'}]
2026-10-09 17:15:01,205 - DEBUG - Payload: {'permission': 'allow', 'roleid': '32a9a765-3d01-4c99-ada1-331c023d2b0d', 'ruleid': '57a86e42-949e-48ef-aa7b-80c6f04f5254', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mqP6uGOLekRd83/HsXHfvYlNhUo='}
2026-10-09 17:15:01,205 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-09 17:15:01,230 - DEBUG - Response : {success : True}
2026-10-09 17:15:01,231 - DEBUG - Payload: {'roleid': '32a9a765-3d01-4c99-ada1-331c023d2b0d', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'I6qku6Xp004mg+uGx8dnLq0pOPs='}
2026-10-09 17:15:01,231 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-09 17:15:01,253 - DEBUG - Response : [{id : '57a86e42-949e-48ef-aa7b-80c6f04f5254', roleid : '32a9a765-3d01-4c99-ada1-331c023d2b0d', rolename : 'MarvinFake Role uac210g5h4', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-09 17:15:01,254 - DEBUG - Payload: {'id': '339ba0ac-87c4-4980-839f-ffe0c5cc0bba', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'3RihURLM8EB1YXyUMnFQ/jbDjE0='}
2026-10-09 17:15:01,254 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:15:01,310 - DEBUG - === Jobid: 74b96321-c4e0-4664-8e56-ea6d2889e887 Started ===
2026-10-09 17:15:01,310 - DEBUG - Payload: {'jobid': '74b96321-c4e0-4664-8e56-ea6d2889e887', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'XzIVtDu/chb2q/l6ji+pWhp+Kyg='}
2026-10-09 17:15:01,310 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:15:01,345 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '339ba0ac-87c4-4980-839f-ffe0c5cc0bba', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:15:01+0000', jobid : '74b96321-c4e0-4664-8e56-ea6d2889e887', jobstatus : 0}
2026-10-09 17:15:02,346 - DEBUG - === JobId:74b96321-c4e0-4664-8e56-ea6d2889e887 is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:15:02,347 - DEBUG - Payload: {'jobid': '74b96321-c4e0-4664-8e56-ea6d2889e887', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'XzIVtDu/chb2q/l6ji+pWhp+Kyg='}
2026-10-09 17:15:02,347 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:15:02,376 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '339ba0ac-87c4-4980-839f-ffe0c5cc0bba', created : '2026-10-09T17:15:01+0000', completed : '2026-10-09T17:15:01+0000', jobid : '74b96321-c4e0-4664-8e56-ea6d2889e887', jobstatus : 1}
2026-10-09 17:15:02,377 - DEBUG - ===Jobid:74b96321-c4e0-4664-8e56-ea6d2889e887 ; StartTime:Fri Oct  9 17:15:01 2026 ; EndTime:Fri Oct  9 17:15:02 2026 ; TotalTime:-1===
2026-10-09 17:15:02,377 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '339ba0ac-87c4-4980-839f-ffe0c5cc0bba', created : '2026-10-09T17:15:01+0000', completed : '2026-10-09T17:15:01+0000', jobid : '74b96321-c4e0-4664-8e56-ea6d2889e887', jobstatus : 1}
2026-10-09 17:15:02,377 - DEBUG - Payload: {'id': '57a86e42-949e-48ef-aa7b-80c6f04f5254', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'7QSiJGejBA8fcnKIDJqIdzHTAXE='}
2026-10-09 17:15:02,377 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:15:02,420 - DEBUG - Response : {success : True}
2026-10-09 17:15:02,421 - DEBUG - Payload: {'id': '32a9a765-3d01-4c99-ada1-331c023d2b0d', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Gqga1zgxQzmmS2Mm5dJ6T1mSkYs='}
2026-10-09 17:15:02,421 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:15:02,471 - DEBUG - Response : {success : True}
2026-10-09 17:15:02,471 - DEBUG - TestCaseName: test_rolepermission_lifecycle_update_permission; Time Taken: 2 Seconds; StartTime: Fri Oct  9 17:14:59 2026; EndTime: Fri Oct  9 17:15:02 2026; Result: SUCCESS
2026-10-09 17:15:02,472 - DEBUG - ::::::::::::STARTED : TC: test_rolepermission_lifecycle_update_permission_negative :::::::::::
2026-10-09 17:15:02,472 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-09 17:15:02,472 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-09 17:15:02,524 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '4.23.0.0-shapeblue20470', userpublictemplateenabled : True, supportELB : 'false', projectinviterequired : False, allowusercreateprojects : True, customdiskofferingminsize : 1, customdiskofferingmaxsize : 1024, regionsecondaryenabled : False, kvmsnapshotenabled : True, snapshotshowchainsize : False, allowuserviewdestroyedvm : True, allowuserexpungerecovervm : True, allowuserexpungerecovervolume : True, allowuserviewalldomainaccounts : False, allowuserforcestopvm : True, kubernetesserviceenabled : True, kubernetesclusterexperimentalfeaturesenabled : False, customhypervisordisplayname : 'Custom', defaultuipagesize : 20, instancesstatsretentiontime : 720, instancesstatsuseronly : False, instancesdisksstatsretentionenabled : False, instancesdisksstatsretentiontime : 720, sharedfsvmmincpucount : 2, sharedfsvmminramsize : 1024, instanceleaseenabled : False, extensionspath : '/usr/share/cloudstack-management/extensions', dynamicscalingenabled : True, additionalconfigenabled : True}
2026-10-09 17:15:02,525 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role 2o8hiszz6n', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'F7Xe//IcESFT6NwuQg13nFF0ox0='}
2026-10-09 17:15:02,525 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-09 17:15:02,560 - DEBUG - Response : {type : 'User', state : 'enabled', id : '0d9a68d8-cad2-41c7-bbe0-eb4f447a6553', name : 'MarvinFake Role 2o8hiszz6n', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-09 17:15:02,561 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '0d9a68d8-cad2-41c7-bbe0-eb4f447a6553', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'cjVPsV/3QhPi5hh0rjSu2cL/SxM='}
2026-10-09 17:15:02,561 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-09 17:15:02,595 - DEBUG - Response : {id : 'a6aaac3f-4556-47e8-8598-cc5362d1a91a', roleid : '0d9a68d8-cad2-41c7-bbe0-eb4f447a6553', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-09 17:15:02,596 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '0d9a68d8-cad2-41c7-bbe0-eb4f447a6553', 'username': 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission_negative-NE4J53', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'KhKC5mmmhtVdEHG4NEQx+lv5+CM='}
2026-10-09 17:15:02,596 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-09 17:15:03,986 - DEBUG - Response : {id : '09a9ec0c-19e3-4002-8c95-f3526f76aaab', name : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission_negative-NE4J53', accounttype : 0, roleid : '0d9a68d8-cad2-41c7-bbe0-eb4f447a6553', roletype : 'User', rolename : 'MarvinFake Role 2o8hiszz6n', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', domainpath : 'ROOT', vmlimit : '20', vmtotal : 0, vmavailable : '20', iplimit : '20', iptotal : 0, ipavailable : '18', volumelimit : '20', volumetotal : 0, volumeavailable : '20', snapshotlimit : '20', snapshottotal : 0, snapshotavailable : '20', backuplimit : '20', backuptotal : 0, backupavailable : '20', backupstoragelimit : '400', backupstoragetotal : 0, backupstorageavailable : '400', templatelimit : '20', templatetotal : 0, templateavailable : '20', vmstopped : 0, vmrunning : 0, projectlimit : '10', projecttotal : 0, projectavailable : '10', networklimit : '20', networktotal : 0, networkavailable : '20', vpclimit : '20', vpctotal : 0, vpcavailable : '20', cpulimit : '40', cputotal : 0, cpuavailable : '40', memorylimit : '40960', memorytotal : 0, memoryavailable : '40960', gpulimit : '20', gputotal : 0, gpuavailable : '20', primarystoragelimit : '200', primarystoragetotal : 0, primarystorageavailable : '200', secondarystoragelimit : '400', secondarystoragetotal : 0.0, secondarystorageavailable : '400.0', bucketlimit : '20', buckettotal : 0, bucketavailable : '20', objectstoragelimit : '400', objectstoragetotal : 0, objectstorageavailable : '400', state : 'enabled', created : '2026-10-09T17:15:03+0000', user : [{id : 'f46eeff9-6c39-4178-8298-a4e106ae2ecb', username : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission_negative-NE4J53', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-09T17:15:03+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission_negative-NE4J53', accounttype : 0, usersource : 'native', roleid : '0d9a68d8-cad2-41c7-bbe0-eb4f447a6553', roletype : 'User', rolename : 'MarvinFake Role 2o8hiszz6n', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domain : 'ROOT', accountid : '09a9ec0c-19e3-4002-8c95-f3526f76aaab', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-09 17:15:03,987 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-09 17:15:03,987 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-09 17:15:04,021 - DEBUG - Response : [{category : 'Advanced', group : 'Miscellaneous', subgroup : 'Certificate Authority', name : 'dynamic.apichecker.cache.period', value : '0', defaultvalue : '0', description : 'Defines the expiration time in seconds for the Dynamic API Checker cache, determining how long cached data is retained before being refreshed. If set to zero then caching will be disabled', isdynamic : False, component : 'RoleService', displaytext : 'Dynamic apichecker cache period', type : 'Number'}]
2026-10-09 17:15:04,021 - DEBUG - Payload: {'permission': 'some_other_value', 'roleid': '0d9a68d8-cad2-41c7-bbe0-eb4f447a6553', 'ruleid': 'a6aaac3f-4556-47e8-8598-cc5362d1a91a', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'/MZbo7k6aqL8zdNjg9laBztwuP0='}
2026-10-09 17:15:04,022 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-09 17:15:04,043 - ERROR - Exception:['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: updaterolepermission failed, due to: errorCode: 431, errorText:Values for permission parameter should be: allow or deny\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: updaterolepermission failed, due to: errorCode: 431, errorText:Values for permission parameter should be: allow or deny
2026-10-09 17:15:04,043 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.updateRolePermission.updateRolePermissionCmd object at 0x7f22470d6d00> Exception: ['Traceback (most recent call last):\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest\n    raise self.__lastError\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse\n    ret = jsonHelper.getResultObj(\n', '  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj\n    raise cloudstackException.CloudstackAPIException(respname, errMsg)\n', 'marvin.cloudstackException.CloudstackAPIException: Execute cmd: updaterolepermission failed, due to: errorCode: 431, errorText:Values for permission parameter should be: allow or deny\n']
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 377, in marvinRequest
    raise self.__lastError
  File "/usr/local/lib/python3.9/site-packages/marvin/cloudstackConnection.py", line 309, in __parseAndGetResponse
    ret = jsonHelper.getResultObj(
  File "/usr/local/lib/python3.9/site-packages/marvin/jsonHelper.py", line 155, in getResultObj
    raise cloudstackException.CloudstackAPIException(respname, errMsg)
marvin.cloudstackException.CloudstackAPIException: Execute cmd: updaterolepermission failed, due to: errorCode: 431, errorText:Values for permission parameter should be: allow or deny
2026-10-09 17:15:04,043 - DEBUG - Payload: {'id': '09a9ec0c-19e3-4002-8c95-f3526f76aaab', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'KNAkiB997tL0eUYXaTpbIegJplo='}
2026-10-09 17:15:04,043 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-09 17:15:04,088 - DEBUG - === Jobid: 42cba1e9-4b32-4c5f-978b-e8c70354a31b Started ===
2026-10-09 17:15:04,089 - DEBUG - Payload: {'jobid': '42cba1e9-4b32-4c5f-978b-e8c70354a31b', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'OXhxVuAkkziEa0UBEQS7H9zhPC4='}
2026-10-09 17:15:04,089 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:15:04,139 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '09a9ec0c-19e3-4002-8c95-f3526f76aaab', managementserverid : 'a4ee800f-a5d4-4d74-bbba-6f1148e2f85e', managementservername : 'pr147-n88-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-09T17:15:04+0000', jobid : '42cba1e9-4b32-4c5f-978b-e8c70354a31b', jobstatus : 0}
2026-10-09 17:15:05,141 - DEBUG - === JobId:42cba1e9-4b32-4c5f-978b-e8c70354a31b is Still Processing, Will TimeOut in:3599 ====
2026-10-09 17:15:05,141 - DEBUG - Payload: {'jobid': '42cba1e9-4b32-4c5f-978b-e8c70354a31b', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'OXhxVuAkkziEa0UBEQS7H9zhPC4='}
2026-10-09 17:15:05,141 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-09 17:15:05,184 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '09a9ec0c-19e3-4002-8c95-f3526f76aaab', created : '2026-10-09T17:15:04+0000', completed : '2026-10-09T17:15:04+0000', jobid : '42cba1e9-4b32-4c5f-978b-e8c70354a31b', jobstatus : 1}
2026-10-09 17:15:05,185 - DEBUG - ===Jobid:42cba1e9-4b32-4c5f-978b-e8c70354a31b ; StartTime:Fri Oct  9 17:15:04 2026 ; EndTime:Fri Oct  9 17:15:05 2026 ; TotalTime:-1===
2026-10-09 17:15:05,185 - DEBUG - Response : {accountid : 'a6719d11-c3f0-11f1-975d-1e002100023e', account : 'admin', domainid : '403e1dfc-c3f0-11f1-975d-1e002100023e', domainpath : 'ROOT', userid : 'a672c44f-c3f0-11f1-975d-1e002100023e', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '09a9ec0c-19e3-4002-8c95-f3526f76aaab', created : '2026-10-09T17:15:04+0000', completed : '2026-10-09T17:15:04+0000', jobid : '42cba1e9-4b32-4c5f-978b-e8c70354a31b', jobstatus : 1}
2026-10-09 17:15:05,185 - DEBUG - Payload: {'id': 'a6aaac3f-4556-47e8-8598-cc5362d1a91a', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'kFy6l3Qywm7Gtk3eoeotO8uTZ3M='}
2026-10-09 17:15:05,185 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-09 17:15:05,226 - DEBUG - Response : {success : True}
2026-10-09 17:15:05,227 - DEBUG - Payload: {'id': '0d9a68d8-cad2-41c7-bbe0-eb4f447a6553', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'gZtBtgiErE6tlYI/24AVvrBYYEA='}
2026-10-09 17:15:05,227 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-09 17:15:05,275 - DEBUG - Response : {success : True}
2026-10-09 17:15:05,275 - DEBUG - TestCaseName: test_rolepermission_lifecycle_update_permission_negative; Time Taken: 2 Seconds; StartTime: Fri Oct  9 17:15:02 2026; EndTime: Fri Oct  9 17:15:05 2026; Result: SUCCESS
2026-10-09 17:15:05,275 - DEBUG - Cleaning up the resources
