2026-10-27 14:50:51,831 - DEBUG - Parsing Test data successful
2026-10-27 14:50:51,832 - DEBUG - Payload: {'account': 'admin', 'command': 'listUsers', 'response': 'json'}
2026-10-27 14:50:51,832 - DEBUG - ========Sending GET Cmd : listUsers=======
2026-10-27 14:50:51,847 - DEBUG - Response : [{id : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', username : 'admin', firstname : 'admin', lastname : 'cloud', created : '2026-10-27T12:05:51+0000', state : 'enabled', account : 'admin', accounttype : 1, usersource : 'native', roleid : '87d83eed-d1fe-11f1-81aa-1e0044000301', roletype : 'Admin', rolename : 'Root Admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', apikey : 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', iscallerchilddomain : False, isdefault : True, is2faenabled : False, is2famandated : False, apikeyaccess : 'INHERIT'}]
2026-10-27 14:50:51,847 - DEBUG - Payload: {'id': 'c1166b9d-d1fe-11f1-81aa-1e0044000301', 'command': 'getUserKeys', 'response': 'json'}
2026-10-27 14:50:51,848 - DEBUG - ========Sending GET Cmd : getUserKeys=======
2026-10-27 14:50:51,859 - DEBUG - Response : {apikey : 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', secretkey : 'R6QPwRUz09TVXBjXNwZk7grTjcPtsFRphH6xhN1oPvnc12YUk296t4KHytg8zRLczDA0X5NsLVi4d8rfMMx3yg', apikeyaccess : True}
2026-10-27 14:50:51,859 - DEBUG - ==== Test Client Creation Successful ====
2026-10-27 14:50:51,888 - DEBUG - ::::::::::::STARTED : TC: test_default_role_deletion :::::::::::
2026-10-27 14:50:51,889 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:50:51,889 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:50:51,919 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:50:51,920 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role pogmfagoaf', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'GmCAzmEVQFjw3x8zoL/uX22ZVn4='}
2026-10-27 14:50:51,920 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:50:51,997 - DEBUG - Response : {type : 'User', state : 'enabled', id : '30c1b960-0fd5-402c-b266-dfcb290080d7', name : 'MarvinFake Role pogmfagoaf', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:50:51,998 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '30c1b960-0fd5-402c-b266-dfcb290080d7', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'wQRVEICih5JhV2dx2mXVIjqRNqk='}
2026-10-27 14:50:51,998 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:50:52,126 - DEBUG - Response : {id : 'f4afed42-7f18-4d00-9927-5dcf35ff0894', roleid : '30c1b960-0fd5-402c-b266-dfcb290080d7', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:50:52,127 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '30c1b960-0fd5-402c-b266-dfcb290080d7', 'username': 'rolete-TestDynamicRoles-test_default_role_deletion-TCKHI5', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'GRcN4yTTsDcG+prQscSTbbtBYi0='}
2026-10-27 14:50:52,127 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:50:53,132 - DEBUG - Response : {id : '2efcd18b-f138-45b8-bd0a-2a174e295db2', name : 'rolete-TestDynamicRoles-test_default_role_deletion-TCKHI5', accounttype : 0, roleid : '30c1b960-0fd5-402c-b266-dfcb290080d7', roletype : 'User', rolename : 'MarvinFake Role pogmfagoaf', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:50:53+0000', user : [{id : '31e33572-aca1-451a-8cc2-177f1bde2ce7', username : 'rolete-TestDynamicRoles-test_default_role_deletion-TCKHI5', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:50:53+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_default_role_deletion-TCKHI5', accounttype : 0, usersource : 'native', roleid : '30c1b960-0fd5-402c-b266-dfcb290080d7', roletype : 'User', rolename : 'MarvinFake Role pogmfagoaf', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : '2efcd18b-f138-45b8-bd0a-2a174e295db2', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:50:53,133 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:50:53,133 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:50:53,159 - 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-27 14:50:53,159 - DEBUG - Payload: {'id': 1, 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'9gomJ8+lw0mfshwNC2za8pIqEbo='}
2026-10-27 14:50:53,160 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:50:53,190 - 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-27 14:50:53,191 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRole.deleteRoleCmd object at 0x7f8d657d7ca0> 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-27 14:50:53,191 - DEBUG - Payload: {'id': 2, 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Ft2MG6SmbvsD2b0u/IHPLyKzalE='}
2026-10-27 14:50:53,191 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:50:53,220 - 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-27 14:50:53,220 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRole.deleteRoleCmd object at 0x7f8d657d75e0> 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-27 14:50:53,221 - DEBUG - Payload: {'id': 3, 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'GUMFiKDoDbpwFxSWjG1ulfIxbrg='}
2026-10-27 14:50:53,221 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:50:53,271 - 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-27 14:50:53,271 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRole.deleteRoleCmd object at 0x7f8d657d6af0> 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-27 14:50:53,272 - DEBUG - Payload: {'id': 4, 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'826sCLYM5ja9sR04EH+YkroSLxM='}
2026-10-27 14:50:53,272 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:50:53,311 - 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-27 14:50:53,311 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRole.deleteRoleCmd object at 0x7f8d657d6130> 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-27 14:50:53,311 - DEBUG - Payload: {'id': '2efcd18b-f138-45b8-bd0a-2a174e295db2', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'HdIbYf/G+vH3OawEexz0fwQCdQ0='}
2026-10-27 14:50:53,312 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:50:53,392 - DEBUG - === Jobid: d551b1db-9386-4087-883a-2f1d60c7ebef Started ===
2026-10-27 14:50:53,392 - DEBUG - Payload: {'jobid': 'd551b1db-9386-4087-883a-2f1d60c7ebef', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'J8xPI5tE+yeVossF2w5KSuHVw+g='}
2026-10-27 14:50:53,392 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:50:53,569 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '2efcd18b-f138-45b8-bd0a-2a174e295db2', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:50:53+0000', jobid : 'd551b1db-9386-4087-883a-2f1d60c7ebef', jobstatus : 0}
2026-10-27 14:50:54,571 - DEBUG - === JobId:d551b1db-9386-4087-883a-2f1d60c7ebef is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:50:54,571 - DEBUG - Payload: {'jobid': 'd551b1db-9386-4087-883a-2f1d60c7ebef', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'J8xPI5tE+yeVossF2w5KSuHVw+g='}
2026-10-27 14:50:54,572 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:50:54,629 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '2efcd18b-f138-45b8-bd0a-2a174e295db2', created : '2026-10-27T14:50:53+0000', completed : '2026-10-27T14:50:54+0000', jobid : 'd551b1db-9386-4087-883a-2f1d60c7ebef', jobstatus : 1}
2026-10-27 14:50:54,629 - DEBUG - ===Jobid:d551b1db-9386-4087-883a-2f1d60c7ebef ; StartTime:Tue Oct 27 14:50:53 2026 ; EndTime:Tue Oct 27 14:50:54 2026 ; TotalTime:-1===
2026-10-27 14:50:54,630 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '2efcd18b-f138-45b8-bd0a-2a174e295db2', created : '2026-10-27T14:50:53+0000', completed : '2026-10-27T14:50:54+0000', jobid : 'd551b1db-9386-4087-883a-2f1d60c7ebef', jobstatus : 1}
2026-10-27 14:50:54,630 - DEBUG - Payload: {'id': 'f4afed42-7f18-4d00-9927-5dcf35ff0894', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'UhKaMduJHrrp/n+sRHXR+xOtA0Q='}
2026-10-27 14:50:54,630 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:50:54,731 - DEBUG - Response : {success : True}
2026-10-27 14:50:54,732 - DEBUG - Payload: {'id': '30c1b960-0fd5-402c-b266-dfcb290080d7', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'z4RigLqfT267ibMnRt1Fqn+UOsw='}
2026-10-27 14:50:54,732 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:50:54,845 - DEBUG - Response : {success : True}
2026-10-27 14:50:54,846 - DEBUG - TestCaseName: test_default_role_deletion; Time Taken: 2 Seconds; StartTime: Tue Oct 27 14:50:51 2026; EndTime: Tue Oct 27 14:50:54 2026; Result: SUCCESS
2026-10-27 14:50:54,847 - DEBUG - ::::::::::::STARTED : TC: test_role_account_acls :::::::::::
2026-10-27 14:50:54,847 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:50:54,847 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:50:54,880 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:50:54,881 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role mjotu8o59w', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'2gMMxrzrJ2wfOPfNMf8KERfJc0Y='}
2026-10-27 14:50:54,881 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:50:54,947 - DEBUG - Response : {type : 'User', state : 'enabled', id : '307b7924-d097-4ea7-a44d-4483214cbbdd', name : 'MarvinFake Role mjotu8o59w', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:50:54,948 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '307b7924-d097-4ea7-a44d-4483214cbbdd', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'CzN1SV5/9ZiPbo1jht7n76OKjlQ='}
2026-10-27 14:50:54,949 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:50:54,995 - DEBUG - Response : {id : 'b8abc3c6-4103-4e81-9b7e-8b484171a38c', roleid : '307b7924-d097-4ea7-a44d-4483214cbbdd', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:50:54,996 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '307b7924-d097-4ea7-a44d-4483214cbbdd', 'username': 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'LR7n4eYf11WjlmJDpX4p5kIZCSY='}
2026-10-27 14:50:54,997 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:50:55,981 - DEBUG - Response : {id : '7643e094-b79d-4125-84b8-81a96a661a2f', name : 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', accounttype : 0, roleid : '307b7924-d097-4ea7-a44d-4483214cbbdd', roletype : 'User', rolename : 'MarvinFake Role mjotu8o59w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:50:56+0000', user : [{id : '2e18e2cb-62d3-462d-9d63-2c57ca74f054', username : 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:50:56+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', accounttype : 0, usersource : 'native', roleid : '307b7924-d097-4ea7-a44d-4483214cbbdd', roletype : 'User', rolename : 'MarvinFake Role mjotu8o59w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : '7643e094-b79d-4125-84b8-81a96a661a2f', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:50:55,981 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:50:55,982 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:50:56,004 - 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-27 14:50:56,005 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '307b7924-d097-4ea7-a44d-4483214cbbdd', 'rule': 'listApis', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'H4qBanxmeINqWJTtSkkGZk3yEWY='}
2026-10-27 14:50:56,005 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:50:56,087 - DEBUG - Response : {id : '68f20bcc-bd54-4ee9-858c-82bc6d9edb04', roleid : '307b7924-d097-4ea7-a44d-4483214cbbdd', rule : 'listApis', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:50:56,088 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '307b7924-d097-4ea7-a44d-4483214cbbdd', 'rule': 'listAccounts', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'LidzCF4K0nDW6/ArgFY+KRgGEqY='}
2026-10-27 14:50:56,088 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:50:56,160 - DEBUG - Response : {id : '13958af8-5a01-4ef9-b0a0-a3ad6b680eff', roleid : '307b7924-d097-4ea7-a44d-4483214cbbdd', rule : 'listAccounts', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:50:56,161 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'deny', 'roleid': '307b7924-d097-4ea7-a44d-4483214cbbdd', 'rule': 'listClusters', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'wmxWsvOuo4d5/tnXWbfaedRk+rY='}
2026-10-27 14:50:56,161 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:50:56,193 - DEBUG - Response : {id : 'd43f955c-5f21-42e2-8015-26894963d23a', roleid : '307b7924-d097-4ea7-a44d-4483214cbbdd', rule : 'listClusters', permission : 'deny', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:50:56,194 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '307b7924-d097-4ea7-a44d-4483214cbbdd', 'rule': '*VM*', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'EDhqBzqzbpLYFju+R81NN5XCTqk='}
2026-10-27 14:50:56,194 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:50:56,242 - DEBUG - Response : {id : '9272c905-e115-4a92-adf9-62e06758c2d1', roleid : '307b7924-d097-4ea7-a44d-4483214cbbdd', rule : '*VM*', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:50:56,243 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'deny', 'roleid': '307b7924-d097-4ea7-a44d-4483214cbbdd', 'rule': '*Host*', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'uNf+2OWusRzrMXgPn/DH8kDeprw='}
2026-10-27 14:50:56,243 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:50:56,311 - DEBUG - Response : {id : 'e8c1aa8d-4c97-4bc6-9a88-02ca2a41e768', roleid : '307b7924-d097-4ea7-a44d-4483214cbbdd', rule : '*Host*', permission : 'deny', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:01,317 - DEBUG - Payload: {'name': 'ROOT', 'command': 'listDomains', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'FUkLFPJq0p6AOaVYSkY//WIQFBk='}
2026-10-27 14:51:01,317 - DEBUG - ========Sending GET Cmd : listDomains=======
2026-10-27 14:51:01,346 - DEBUG - Response : [{id : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27 14:51:01,347 - DEBUG - Payload: {'listall': True, 'name': 'ROOT', 'command': 'listDomains', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'MTo4M/OsRVaY9H/KZqvgm9hNmEQ='}
2026-10-27 14:51:01,347 - DEBUG - ========Sending GET Cmd : listDomains=======
2026-10-27 14:51:01,374 - DEBUG - Response : [{id : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27 14:51:01,375 - DEBUG - Payload: {'domainid': '54e5326a-d1fe-11f1-81aa-1e0044000301', 'listall': True, 'name': 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', 'command': 'listAccounts', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'4TWwx3dF0YxbfMj0MFLuPnA4qAE='}
2026-10-27 14:51:01,376 - DEBUG - ========Sending GET Cmd : listAccounts=======
2026-10-27 14:51:01,432 - DEBUG - Response : [{id : '7643e094-b79d-4125-84b8-81a96a661a2f', name : 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', accounttype : 0, roleid : '307b7924-d097-4ea7-a44d-4483214cbbdd', roletype : 'User', rolename : 'MarvinFake Role mjotu8o59w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:50:56+0000', user : [{id : '2e18e2cb-62d3-462d-9d63-2c57ca74f054', username : 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:50:56+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', accounttype : 0, usersource : 'native', roleid : '307b7924-d097-4ea7-a44d-4483214cbbdd', roletype : 'User', rolename : 'MarvinFake Role mjotu8o59w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : '7643e094-b79d-4125-84b8-81a96a661a2f', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}]
2026-10-27 14:51:01,433 - DEBUG - Payload: {'domainid': '54e5326a-d1fe-11f1-81aa-1e0044000301', 'listall': True, 'username': 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', 'command': 'listUsers', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'UtX9XSZMfr+EK7wpvO7pE8E1uVs='}
2026-10-27 14:51:01,433 - DEBUG - ========Sending GET Cmd : listUsers=======
2026-10-27 14:51:01,474 - DEBUG - Response : [{id : '2e18e2cb-62d3-462d-9d63-2c57ca74f054', username : 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:50:56+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', accounttype : 0, usersource : 'native', roleid : '307b7924-d097-4ea7-a44d-4483214cbbdd', roletype : 'User', rolename : 'MarvinFake Role mjotu8o59w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : '7643e094-b79d-4125-84b8-81a96a661a2f', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False, apikeyaccess : 'INHERIT'}]
2026-10-27 14:51:01,475 - DEBUG - Payload: {'id': '2e18e2cb-62d3-462d-9d63-2c57ca74f054', 'command': 'getUserKeys', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'PinwqGXNbJk2VBE8KkwR3WTvy80='}
2026-10-27 14:51:01,475 - DEBUG - ========Sending GET Cmd : getUserKeys=======
2026-10-27 14:51:01,506 - DEBUG - Response : {apikeyaccess : True}
2026-10-27 14:51:01,507 - ERROR - __createApiClient: API Client Creation Failed
2026-10-27 14:51:01,507 - DEBUG - Payload: {'id': '2e18e2cb-62d3-462d-9d63-2c57ca74f054', 'name': 'keypair-2e18e2cb-62d3-462d-9d63-2c57ca74f054', 'command': 'registerUserKeys', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'qNpgOijEJfgTm5LJupMnDRBiWFg='}
2026-10-27 14:51:01,507 - DEBUG - ========Sending GET Cmd : registerUserKeys=======
2026-10-27 14:51:02,807 - DEBUG - Response : {name : 'keypair-2e18e2cb-62d3-462d-9d63-2c57ca74f054', apikey : 'uTvwB1RgbKKNifROZqNRyG37LlpF4kjTFsZ1C68kaHfKELaOqKnTc4PA52iVUikCC8UnyIKhXDFu4jZ-YgNHsg', secretkey : '-baOk0v_pdN346vh0K_Qg6leDSwb523lhTd8bZgMcROj4JLw7wMejxW-XNiaxv_pJQF8nJHnbfCnaqrlcD7TQg', userid : '2e18e2cb-62d3-462d-9d63-2c57ca74f054', username : 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', id : '4d0f1902-7492-4aef-85e7-e2f5dc24552f', created : '2026-10-27T14:51:03+0000', accounttype : 'NORMAL', accountid : '7643e094-b79d-4125-84b8-81a96a661a2f', accountname : 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', roleid : '307b7924-d097-4ea7-a44d-4483214cbbdd', roletype : 'User', rolename : 'MarvinFake Role mjotu8o59w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', domainpath : 'ROOT', state : 'ENABLED'}
2026-10-27 14:51:02,808 - DEBUG - Payload: {'id': '2e18e2cb-62d3-462d-9d63-2c57ca74f054', 'command': 'getUserKeys', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'PinwqGXNbJk2VBE8KkwR3WTvy80='}
2026-10-27 14:51:02,808 - DEBUG - ========Sending GET Cmd : getUserKeys=======
2026-10-27 14:51:03,020 - DEBUG - Response : {apikey : 'uTvwB1RgbKKNifROZqNRyG37LlpF4kjTFsZ1C68kaHfKELaOqKnTc4PA52iVUikCC8UnyIKhXDFu4jZ-YgNHsg', secretkey : '-baOk0v_pdN346vh0K_Qg6leDSwb523lhTd8bZgMcROj4JLw7wMejxW-XNiaxv_pJQF8nJHnbfCnaqrlcD7TQg', apikeyaccess : True}
2026-10-27 14:51:03,020 - DEBUG - Payload: {'command': 'listApis', 'response': 'json', 'apiKey': 'uTvwB1RgbKKNifROZqNRyG37LlpF4kjTFsZ1C68kaHfKELaOqKnTc4PA52iVUikCC8UnyIKhXDFu4jZ-YgNHsg', 'signature': b'eO9hzjVeReprM2xXn8sLpOIF5tE='}
2026-10-27 14:51:03,021 - DEBUG - ========Sending GET Cmd : listApis=======
2026-10-27 14:51:03,451 - 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 : '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 : 'deleteVmwareCbtMigration', description : 'Deletes a failed, cancelled or completed VMware CBT migration record. Failed and cancelled migrations can optionally clean up replicated target disks; completed migrations are record-only deletes.', since : '4.24.0', isasync : False, params : [{name : 'id', description : 'the VMware CBT migration ID', type : 'uuid', length : 255, required : True, related : 'startVmwareCbtMigration,listVmwareCbtMigrations,syncVmwareCbtMigration,cutoverVmwareCbtMigration,cancelVmwareCbtMigration'}, {name : 'cleanup', description : 'If true, clean up replicated target disks before removing a failed or cancelled migration record. True by default. Ignored for completed migrations.', 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 : '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'}], 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 : '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 : 'rebootSystemVm', description : 'Reboots a system VM.', isasync : True, related : 'destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm', params : [{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'}, {name : 'id', description : 'The ID of the System VM', type : 'uuid', length : 255, required : True, related : 'destroySystemVm,listSystemVms,migrateSystemVm,rebootSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm'}], response : [{name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the System VM', 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 : '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 : 'hypervisor', description : 'The hypervisor on which the Template runs', 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 : '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 : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'agentstate', description : 'The agent 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 : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID 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 : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', 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 : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'podname', description : 'The Pod name 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 : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {}, {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 : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'linklocalmacaddress', description : 'The link local MAC address 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 : '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'}, {name : 'id', description : 'the ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster,removeNodesFromKubernetesCluster,updateKubernetesClusterAffinityGroups'}], response : [{name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'name', description : 'The name 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 : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID 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 : '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 : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {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 : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'controlofferingname', description : 'the name 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 : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'networkid', description : 'The ID of the network of 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 : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd 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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of 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 : '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 : '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 : 'id', description : 'the ID of the OAuth provider', type : 'uuid', length : 255, required : False, related : 'listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'provider', description : 'Name of the provider', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'name', description : 'Name of the provider', type : 'string'}, {name : 'tokenurl', description : 'Token URL registered in the OAuth provider', type : 'string'}, {name : 'secretkey', description : 'Secret key registered in the OAuth provider', type : 'string'}, {name : 'authorizeurl', description : 'Authorize URL registered in the OAuth provider', type : 'string'}, {name : 'redirecturi', description : 'Redirect URI registered in the OAuth provider', type : 'string'}, {name : 'id', description : 'ID of the provider', type : 'string'}, {name : 'clientid', description : 'Client ID registered in the OAuth provider', type : 'string'}, {name : 'domain', description : 'name of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'domainid', description : 'UUID 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 : '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 : 'description', description : 'Description of the provider registered', 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 : 'updateSharedFileSystem', description : 'Update a Shared FileSystem', since : '4.20.0', isasync : False, related : 'createSharedFileSystem,listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering', params : [{name : 'name', description : 'the name of the shared filesystem.', type : 'string', length : 255, required : False}, {name : 'description', description : 'the description for 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 : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'volumename', description : 'name of the storage fs data volume', 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 : '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 : '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 : 'key', description : 'Tag key name', 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 : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'zoneid', description : 'ID of the availability zone', 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 : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'domain', description : 'the domain associated with 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 : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {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 : '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 : 'isolationuri', description : 'The isolation URI of the NIC', 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 : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {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 : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', 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 : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'id', description : 'The ID of the NIC', 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 : 'networkname', description : 'The name of the corresponding Network', 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 : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 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 : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}]}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'utilization', description : 'the disk utilization', 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 : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with 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 : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'privateip', description : 'The private IP 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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {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 : '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 : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', 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 : '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 : '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 : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {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 : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}], httprequesttype : 'POST'}, {name : 'listASNumbers', description : 'List Autonomous Systems Numbers', since : '4.20.0', isasync : False, related : '', params : [{name : 'keyword', description : 'List by keyword', type : 'string', 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 : 'asnrangeid', description : 'the AS Number range ID', type : 'uuid', length : 255, required : False, related : 'createASNRange,listASNRanges'}, {name : 'asnumber', description : 'AS number', type : 'integer', length : 255, required : False, related : 'listASNumbers'}, {name : 'account', description : 'account name', type : 'string', length : 255, required : False, related : 'createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts'}, {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 : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'domainid', description : 'domain id', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'isallocated', description : 'to indicate if the AS number is allocated to any network', type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'vpcname', description : 'VPC Name', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'allocationstate', description : 'Allocation state', type : 'string'}, {name : 'asnumber', description : 'AS Number', type : 'long'}, {}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'allocated', description : 'Allocated Date', type : 'date'}, {name : 'asnrange', description : 'AS Number Range', type : 'string'}, {name : 'id', description : 'ID of the AS Number', type : 'string'}, {name : 'created', description : 'Created Date', type : 'date'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'asnrangeid', description : 'AS Number ID', type : 'string'}, {name : 'domain', description : 'the domain name', type : 'string'}, {name : 'accountid', description : 'Account ID', type : 'string'}, {name : 'associatednetworkid', description : 'Network ID', type : 'string'}, {name : 'associatednetworkname', description : 'Network Name', type : 'string'}, {name : 'vpcid', description : 'VPC ID', type : 'string'}, {name : 'zonename', description : 'the zone name of the AS Number range', type : 'string'}, {name : 'domainid', description : 'Domain ID', type : 'string'}], httprequesttype : 'GET'}, {name : 'listUserData', description : 'List registered userdatas', since : '4.18', isasync : False, related : 'listCniConfiguration', params : [{name : 'id', description : 'The ID of the Userdata', type : 'uuid', length : 255, required : False, related : 'listUserData,listCniConfiguration'}, {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 : '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 : '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 : '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,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}], response : [{}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'Name of the User Data', type : 'string'}, {name : 'domain', description : 'The domain name of the User Data owner', type : 'string'}, {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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'account', description : 'The owner of the User Data', type : 'string'}, {name : 'domainid', description : 'The domain id of the User Data owner', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the User Data owner belongs', type : 'string'}, {name : 'projectid', description : 'The project id of the User Data', type : 'string'}, {name : 'userdata', description : 'Base64 encoded User Data content', type : 'string'}, {name : 'id', description : 'ID of the User Data', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {}, {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'}], 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 : 'id', description : 'The ID of the system vm', type : 'uuid', length : 255, required : True, related : 'listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm'}, {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 : 'serviceofferingid', description : 'The service offering ID to apply to the system vm', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,cloneServiceOffering,updateServiceOffering,listServiceOfferings'}], response : [{name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'arch', description : 'CPU arch of 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 : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {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 : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {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 : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {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 : '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 : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', 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 : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}], 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 : '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 : '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'}, {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'}, {name : 'secretcode', description : 'Code that is provided by OAuth provider (Eg. google, github) after successful login', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{}, {name : 'domain', description : 'name of the domain the provider belongs to (empty for global)', type : 'string'}, {}, {name : 'domainpath', description : 'path of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'domainid', description : 'UUID of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'tokenurl', description : 'Token URL registered in the OAuth provider', type : 'string'}, {name : 'id', description : 'ID of the provider', type : 'string'}, {name : 'description', description : 'Description of the provider registered', type : 'string'}, {name : 'secretkey', description : 'Secret key registered in the OAuth provider', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'redirecturi', description : 'Redirect URI registered in the OAuth 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'}, {name : 'name', description : 'Name of the provider', 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 : 'provider', description : 'Name of the provider', type : 'string'}], httprequesttype : 'GET'}, {name : 'createBackupSchedule', description : 'Creates a User-defined Instance backup schedule', since : '4.14.0', isasync : False, related : 'listBackupSchedule', 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 : '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 : '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,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 : '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'}], response : [{}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'intervaltype', description : 'The interval type of the backup schedule', type : 'intervaltype'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'schedule', description : 'The time the backup is scheduled to be taken.', type : 'string'}, {name : 'timezone', description : 'The time zone 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 : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {}, {name : 'maxbackups', description : 'maximum number of backups retained', type : 'integer'}, {name : 'id', description : 'ID of the backup schedule.', type : 'string'}, {name : 'quiescevm', description : 'quiesce the instance before checkpointing the disks for backup', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listKMSKeys', description : 'Lists KMS keys available to the caller', since : '4.23.0', isasync : False, related : 'createKMSKey,updateKMSKey', 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 : '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 : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {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 : '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 : '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 : 'zoneid', description : 'Filter by zone ID', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,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}], response : [{name : 'zoneid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'enabled', description : 'whether the key is enabled', type : 'boolean'}, {name : 'algorithm', description : 'the encryption algorithm', type : 'string'}, {name : 'id', description : 'the UUID of the key', type : 'string'}, {name : 'domainpath', description : 'the domain path of the key', type : 'string'}, {name : 'version', description : 'the key size in bits', type : 'integer'}, {name : 'hsmprofileid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'project', description : 'the project name of the key', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', 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 : 'domain', description : 'the domain name of the key', type : 'string'}, {}, {name : 'created', description : 'the creation timestamp', type : 'date'}, {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 : 'accountid', description : 'the account ID owning the key', type : 'string'}, {name : 'domainid', description : 'the domain ID of the key', type : 'string'}, {name : 'keybits', description : 'the key size in bits', type : 'integer'}, {name : 'projectid', description : 'the project ID of the key', type : 'string'}, {name : 'description', description : 'the description of the key', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'cleanVMReservations', description : 'Cleanups Instance reservations in the database.', isasync : True, params : [], 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 : 'updateRoutingFirewallRule', description : 'Updates Routing firewall rule with specified ID', since : '4.20.0', isasync : True, related : 'createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule', params : [{name : 'id', description : 'the ID of the Routing firewall rule', type : 'uuid', length : 255, required : True, related : 'createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule'}, {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 : '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 : 'privateendport', description : "The ending port of port forwarding rule's private port range", 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 : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', 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 : 'domainid', description : 'The ID 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 : 'domain', description : '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 : '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 : 'projectid', description : 'The project ID the tag belongs to', 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 : 'networkid', description : 'The ID of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'virtualmachinedisplayname', description : 'The Instance display 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 : 'state', description : 'The state of the rule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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 : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'listObjectStoragePools', description : 'Lists object storage pools.', since : '4.19.0', isasync : False, related : 'addObjectStoragePool,updateObjectStoragePool', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'the ID of the storage pool', type : 'uuid', length : 255, required : False, related : 'addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'provider', description : 'the object store provider', type : 'string', length : 255, required : False}, {name : 'name', description : 'the name of the object store', type : 'string', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'storagetotal', description : 'the total size of the object store', type : 'long'}, {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 : 'storageallocated', description : 'the allocated size of the object store', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'storageused', description : 'the object store currently used size', type : 'long'}, {name : 'id', description : 'the ID of the object store', type : 'string'}, {name : 'url', description : 'the url of the object store', type : 'string'}, {}, {name : 'name', description : 'the name of the object store', type : 'string'}, {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 : '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'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'runCustomAction', description : 'Run the custom action', since : '4.21.0', isasync : True, related : '', params : [{name : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : False}, {name : 'customactionid', description : 'ID of the custom action', type : 'uuid', length : 255, required : True, related : 'addCustomAction,listCustomActions'}, {name : 'resourceid', description : 'ID of the instance', type : 'string', length : 255, required : True}, {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 : 'name', description : 'Name of the action', type : 'string'}, {name : 'success', description : 'Whether custom action succeed or not', type : 'boolean'}, {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'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'listDnsRecords', description : 'Lists DNS records from the external provider', since : '4.23.0', isasync : False, related : 'createDnsRecord', params : [{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'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{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'}, {}, {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'}], httprequesttype : 'GET'}, {name : 'createBackup', description : 'Create Instance backup', since : '4.14.0', isasync : True, params : [{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 : 'name', description : 'the name of the backup', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'description', description : 'the description for the backup', type : 'string', length : 255, required : False, since : '4.21.0'}, {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 : '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'}], 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 : '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 : '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 : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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 : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'id', description : 'The ID of 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 : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'hostid', description : 'The host 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 : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'serviceofferingname', description : 'the name 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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}], httprequesttype : 'POST'}, {name : 'listIpv6FirewallRules', description : 'Lists all IPv6 firewall rules', isasync : False, related : 'createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule', params : [{name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', 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 : '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 : '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 : 'page', 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 : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'id', description : 'Lists IPv6 firewall rule with the specified ID', type : 'uuid', length : 255, required : False, related : 'createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule'}, {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 : 'fordisplay', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{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 : 'value', description : 'Tag value', 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 : 'customer', description : 'Customer 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 : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', 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 : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', 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 : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'protocol', description : 'The protocol of the port forwarding rule', 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 : 'privateendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {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 : 'networkname', description : 'The Name 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}], httprequesttype : 'GET'}, {name : 'listVMSchedule', description : 'List Instance Schedules.', since : '4.19.0', isasync : False, related : 'createVMSchedule,updateVMSchedule', params : [{name : 'enabled', description : 'Filter by enabled status', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'ID of Instance schedule', type : 'uuid', length : 255, required : False, related : 'createVMSchedule,listVMSchedule,updateVMSchedule'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'action', description : 'Action taken by schedule', type : 'string', 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 : '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'}], response : [{name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'action', description : 'Action', type : 'action'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'The ID of Instance schedule', type : 'string'}, {}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {}, {name : 'description', description : 'Description of Instance schedule', type : 'string'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'schedule', description : 'Cron formatted Instance schedule', type : 'string'}, {name : 'enabled', description : 'VM schedule is enabled', type : 'boolean'}, {name : 'virtualmachineid', description : 'ID of Instance', 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'}], 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 : '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 : '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 : '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 : '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 : '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}, {name : 'mountcksisoonvr', description : '(optional) Vmware only, uses the CKS cluster network VR to mount the CKS ISO', type : 'boolean', length : 255, required : False}], response : [{name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {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 : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on 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 : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of 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 : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'memory', description : 'The memory the Kubernetes cluster', 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 : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {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 : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {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 : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'name', description : 'The name 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 : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the 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 : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupids', description : 'The IDs 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'}, {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 : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}], httprequesttype : 'POST'}, {name : 'listVolumesMetrics', description : 'Lists volume metrics', since : '4.9.3', isasync : False, related : '', params : [{name : 'diskofferingid', description : 'List volumes by disk offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'createDiskOffering,cloneDiskOffering,updateDiskOffering,listDiskOfferings'}, {name : 'name', description : 'The name of the disk volume', 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 : 'zoneid', description : 'The ID of the availability zone', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'page', description : '', type : 'integer', 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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The ID of the disk volume', type : 'uuid', length : 255, required : False, related : 'importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}, {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 : '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 : 'type', description : 'The type of disk volume', type : 'string', length : 255, required : False}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', 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 : '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 : '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 : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'isencrypted', description : 'list only volumes that are encrypted', type : 'boolean', length : 255, required : False, since : '4.19.1'}, {name : 'state', description : 'State of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.', type : 'string', 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 : 'importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}, {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 : 'hostid', description : 'List volumes on specified host', type : 'uuid', length : 255, required : False, related : 'addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost'}, {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 : 'clusterid', description : 'The cluster ID the disk volume belongs to', type : 'uuid', length : 255, required : False, related : 'addCluster,updateCluster'}, {name : 'podid', description : 'The pod ID the disk volume belongs to', type : 'uuid', length : 255, required : False, related : 'createPod,listPods,updatePod,createManagementNetworkIpRange'}, {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 : 'listsystemvms', description : 'List system VMs; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.18'}], response : [{name : 'diskiopstotal', description : 'The total disk iops', type : 'long'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {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 : 'isoid', description : 'The ID 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 : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'sizegb', description : 'Disk size in GiB', type : 'string'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'state', description : 'The state of the disk volume', 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 : 'value', description : 'Tag value', type : 'string'}, {name : 'domain', description : '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 : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', 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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', 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 : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', 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 : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', 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 : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'vmstate', description : 'State of the Instance', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}], 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 : '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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{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 : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {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 : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', 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 : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}]}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'ostypeid', description : 'OS type id 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 : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', 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 : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", 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 : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {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 : '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 : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {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 : 'type', description : 'The type of the NIC', 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 : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', 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 : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', 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 : '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 : '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 : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', 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 : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', 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 : '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 : '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 : '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 : '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 : '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 : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', 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 : 'value', description : 'Tag value', 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 : 'securitygroupname', description : 'Security group name', type : 'string'}]}, {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 : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'projectid', description : 'The project id 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 : '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 : '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 : 'key', description : 'Tag key name', 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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', 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 : '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 : 'endport', description : 'The ending 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 : '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 : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {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 : 'domainpath', description : 'Path 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 : 'projectid', description : 'The project ID the tag belongs to', 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 name of the security group', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {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 : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', 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 : '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 : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}]}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', 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 : 'name', description : 'The name of the Instance', type : 'string'}, {}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {}, {name : 'serviceofferingid', description : 'The ID of the service offering of 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 : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'pooltype', description : 'The pool type 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'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", 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 : '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 : '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 : '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 : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', 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 : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', 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 : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'rootdevicetype', description : 'Device type of the root volume', 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 : 'ip6dns1', description : 'The first IPv6 DNS for the router', type : 'string'}, {name : 'vpcid', description : 'VPC the router belongs to', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the router', type : 'string'}, {name : 'publicnetworkid', description : 'The ID of the corresponding public Network', type : 'string'}, {name : 'id', description : 'The ID of the router', type : 'string'}, {name : 'hostname', description : 'The hostname for the router', type : 'string'}, {name : 'healthchecksfailed', description : 'True if any health checks had failed', type : 'boolean'}, {name : 'redundantstate', description : 'The state of redundant virtual router', type : 'string'}, {name : 'gateway', description : 'The gateway for the router', type : 'string'}, {name : 'publicip', description : 'The public IP address for the router', type : 'string'}, {name : 'guestmacaddress', description : 'The guest MAC address for the router', type : 'string'}, {name : 'account', description : 'The Account associated with the router', type : 'string'}, {name : 'podid', description : 'The Pod ID for the router', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the router belongs to', type : 'string'}, {name : 'guestnetmask', description : 'The guest netmask for the router', type : 'string'}, {name : 'hostid', description : 'The host ID for the router', 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 : 'linklocalnetworkid', description : 'The ID of the corresponding link local Network', type : 'string'}, {name : 'ip6dns2', description : 'The second IPv6 DNS for the router', 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 : 'linklocalnetmask', description : 'The link local netmask for the router', type : 'string'}, {name : 'templateid', description : 'The Template ID for the router', type : 'string'}, {name : 'domainid', description : 'The domain ID associated with the router', type : 'string'}, {name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {}, {name : 'requiresupgrade', description : 'True if the router Template requires upgrade', type : 'boolean'}, {name : 'role', description : 'Role of the domain router', type : 'string'}, {name : 'publicmacaddress', description : 'The public 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 : 'healthcheckresults', description : 'Last executed health check result for the router', type : 'list', response : [{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 : '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 : 'status', description : 'the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}', type : 'routerhealthstatus'}, {name : 'lastupdated', description : 'The date this VPC was created', type : 'date'}]}, {name : 'dns2', description : 'The second DNS for the router', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'project', description : 'The project name of the address', type : 'string'}, {name : 'state', description : 'The state of the router', type : 'state'}, {name : 'isredundantrouter', description : 'If this router is an redundant virtual router', type : 'boolean'}, {name : 'guestnetworkid', description : 'The ID of the corresponding guest Network', type : 'string'}, {name : 'version', description : 'The version of Template', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the router', type : 'string'}, {name : 'guestnetworkname', description : 'The name of the corresponding guest Network', 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 router', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with the router', type : 'set', response : [{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 : '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 : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {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 : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding 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 : '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 : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', 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 : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', 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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'traffictype', description : 'The traffic type 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 : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', 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 : 'hostcontrolstate', description : 'The control state of the host for the router', 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 : 'guestipaddress', description : 'The guest IP address for the router', type : 'string'}, {name : 'podname', description : 'The Pod name for the router', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the router', type : 'string'}, {name : 'templatename', description : 'The Template name for the router', type : 'string'}, {name : 'domain', description : 'The domain associated with the router', type : 'string'}, {name : 'arch', description : 'CPU arch of the router', type : 'string'}, {name : 'softwareversion', description : 'The version of the code / software in the router', type : 'string'}, {name : 'scriptsversion', description : 'The version of scripts', type : 'string'}, {name : 'name', description : 'The name of 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 : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {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}], 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 : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'listKubernetesClusters', description : 'Lists Kubernetes clusters', isasync : False, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'page', description : '', type : 'integer', 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}, {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 : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : False, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {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 Kubernetes cluster', 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 : 'clustertype', description : 'Type of the cluster: CloudManaged, ExternalManaged', type : 'string', length : 255, required : False, since : '4.19.0'}, {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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {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}], response : [{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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', 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 Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'templatename', description : 'the name of the template 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 : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {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 : 'controlofferingname', description : 'the name 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 : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {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 : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', 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 : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'endpoint', description : 'URL end point for 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 : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {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 : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {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 : 'description', description : 'The description 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 : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', 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 : '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 : '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 : 'scaledownpolicyids', description : 'List of scaledown autoscale policies', type : 'list', length : 255, required : True, related : 'listAutoScalePolicies,updateAutoScalePolicy'}, {name : 'lbruleid', description : 'The ID of the load balancer rule', type : 'uuid', length : 255, required : True, related : 'createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule'}, {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 : 'interval', description : 'The frequency in which the performance counters to be collected', type : 'integer', length : 255, required : False}, {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}], response : [{name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {name : 'publicipid', description : 'The public IP address ID', type : 'string'}, {name : 'projectid', description : 'The project id of the Instance group', type : 'string'}, {name : 'publicip', description : 'The public IP address', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {name : 'privateport', description : 'The private port', type : 'string'}, {}, {name : 'publicport', description : 'The public port', type : 'string'}, {name : 'lbprovider', description : 'The LB provider of the guest Network the LB rule belongs to', 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 : '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 : '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 : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'associatednetworkname', description : 'The name of the guest Network the LB rule belongs to', type : 'string'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {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 : '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 : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}], httprequesttype : 'POST'}, {name : 'createNetworkPermissions', description : 'Updates network permissions.', since : '4.17.0', isasync : False, params : [{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'}, {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'}], 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 : '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 : '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 : '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 : 'importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume', params : [{name : 'repair', description : 'parameter to repair the volume, leaks or all are the possible values', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the volume', type : 'uuid', length : 255, required : True, related : 'importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}], response : [{name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', 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 : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', 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 : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {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 : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', 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 : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'vmstate', description : 'State 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 : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {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 : 'key', description : 'Tag key name', type : 'string'}, {name : 'domain', description : 'The domain 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 : 'customer', description : 'Customer associated with the tag', 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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}], 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 : '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 : '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 : '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 : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'publicport', description : 'The public port', 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 : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'project', description : 'The project name of the 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 : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}, {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 : 'name', description : 'The name of the autoscale 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 : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the guest Network the LB rule belongs to', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainid', description : 'The domain ID 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 : '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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'publicip', description : 'The public IP address', 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'}], httprequesttype : 'POST'}, {name : 'listSystemVms', description : 'List System VMs.', isasync : False, related : 'migrateSystemVm,startSystemVm,changeServiceForSystemVm', params : [{name : 'arch', description : 'CPU arch of the system VM', type : 'string', length : 255, required : False, since : '4.20.1'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {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 : 'name', description : 'The name of the system VM', type : 'string', 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 : 'addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost'}, {name : 'systemvmtype', description : 'The system VM type. Possible types are "consoleproxy" and "secondarystoragevm".', type : 'string', length : 255, required : False}, {name : 'podid', description : 'The Pod ID of the system VM', type : 'uuid', length : 255, required : False, related : 'createPod,listPods,updatePod,createManagementNetworkIpRange'}, {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 : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'state', description : 'The state of the system VM', type : 'string', length : 255, required : False}], response : [{name : 'agentstate', description : 'The agent state of 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 : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {}, {name : 'privatemacaddress', description : 'The private MAC address 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 : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'dns2', description : 'The second DNS 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 : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', 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 : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', 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 : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}], httprequesttype : 'GET'}, {name : 'listInstanceBootGroupReadinessRules', description : 'Lists readiness rules for an Instance Boot Group', since : '24.0', isasync : False, related : 'createInstanceBootGroupReadinessRule,updateInstanceBootGroupReadinessRule', params : [{name : 'virtualmachineid', description : 'List rules for 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,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 : 'ruletype', description : 'Filter by readiness rule type', type : 'string', 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 : 'bootgroupid', description : 'The ID of the Instance Boot Group; listing is always scoped to one boot group', type : 'uuid', length : 255, required : True, related : 'createInstanceBootGroup,updateInstanceBootGroup,listInstanceBootGroups,startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup'}, {name : 'id', description : 'List by readiness rule ID', type : 'uuid', length : 255, required : False, related : 'createInstanceBootGroupReadinessRule,updateInstanceBootGroupReadinessRule,listInstanceBootGroupReadinessRules'}, {name : 'instancegroupid', description : 'List rules for the Instance Group', type : 'uuid', length : 255, required : False, related : 'createInstanceGroup,updateInstanceGroup'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'name', description : 'The name of the readiness rule', type : 'string'}, {}, {name : 'memberid', description : 'The ID of the item (VM or instance group) this rule applies to', type : 'string'}, {name : 'statusmessage', description : 'The message from the last evaluation of this rule', type : 'string'}, {name : 'details', description : 'Rule-type-specific configuration', type : 'map'}, {name : 'checkedon', description : 'When this rule was last evaluated', type : 'date'}, {name : 'membertype', description : 'The item type this rule applies to: VirtualMachine or InstanceGroup', type : 'string'}, {name : 'membername', description : 'The name of the item (VM or instance group) this rule applies to', type : 'string'}, {name : 'readinessstatus', description : 'The last cached evaluation status of this rule: READY, NOT_READY, ERROR or UNKNOWN', type : 'string'}, {name : 'enabled', description : 'Whether the rule is enabled', type : 'boolean'}, {name : 'id', description : 'The ID of the readiness rule', type : 'string'}, {}, {name : 'bootgroupid', description : 'The ID of the boot group this rule belongs to', type : 'string'}, {name : 'ruletype', description : 'The readiness rule type', type : 'string'}, {name : 'created', description : 'The date the rule was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'inherited', description : "True if this rule is not attached to the queried item directly, but inherited from its owning InstanceGroup (only possible when listing by virtualmachineid; the rule's itemtype/itemid still refer to the InstanceGroup it's actually attached to)", type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'createVMSchedule', description : 'Create Instance Schedule', since : '4.19.0', isasync : False, related : 'updateVMSchedule', params : [{name : 'action', description : 'Action to take on the Instance (start/stop/reboot/force_stop/force_reboot).', type : 'string', length : 255, required : True}, {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 : '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 : '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 : '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 : 'enabled', description : 'Enable Instance schedule. Defaults to true', type : 'boolean', length : 255, required : False}, {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}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {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 : '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 : '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 : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {}, {name : 'id', description : 'The ID of Instance schedule', type : 'string'}], 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 : '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 : 'enabled', description : 'Enable schedule. Defaults to true', type : 'boolean', length : 255, required : False}, {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 : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : True}, {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 : 'action', description : 'Action to take on the resource.', type : 'string', length : 255, required : True}, {name : 'description', description : 'Description of the schedule', type : 'string', length : 255, required : False}, {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}], response : [{name : 'action', description : 'Action', type : 'action'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {}, {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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'enabled', description : 'Resource schedule is enabled', type : 'boolean'}, {name : 'details', description : 'Schedule details', type : 'map'}, {name : 'id', description : 'The ID of resource schedule', type : 'string'}, {name : 'resourcetype', description : 'Type of the resource', type : 'apicommandresourcetype'}, {name : 'schedule', description : 'Cron formatted resource schedule', type : 'string'}, {name : 'description', description : 'Description of resource schedule', type : 'string'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'timezone', description : 'Timezone of the 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 : '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 : '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 : '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 : 'description', description : 'the description for the shared filesystem.', type : 'string', length : 255, required : False}, {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 : 'name', description : 'the name of the shared filesystem.', type : 'string', length : 255, required : True}, {name : 'account', description : 'the account associated with the shared filesystem. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {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 : 'size', description : 'the size of the shared filesystem in GiB', 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 : 'miniops', description : 'min iops', type : 'long', length : 255, required : False}, {name : 'zoneid', description : 'the zone id.', type : 'uuid', length : 255, required : True, related : 'createZone,updateZone,listZones,listZones'}, {name : 'maxiops', description : 'max iops', type : 'long', length : 255, required : False}], response : [{name : 'domain', description : '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 : '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 : '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 : '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 : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}]}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', 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 : '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 : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', 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 : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {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 : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID 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 : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {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 : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {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 : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {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 : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'project', description : 'the project name of 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 : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', 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 shared filesystem', type : 'string'}, {name : 'id', description : 'ID of 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 : '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 : 'updateVmwareDc', description : 'Updates a VMware datacenter details for a zone', since : '4.12.0', isasync : False, related : 'addVmwareDc,listVmwareDcs', params : [{name : 'name', description : 'VMware datacenter name.', type : 'string', length : 255, required : False}, {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}], response : [{name : 'id', description : 'The VMware Datacenter ID', type : 'string'}, {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'}, {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 : '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 : '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 : 'updateInstanceBootGroup', description : 'Updates an Instance Boot Group', since : '24.0', isasync : False, related : 'createInstanceBootGroup,listInstanceBootGroups,startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup', params : [{name : 'name', description : 'New name for the Instance Boot Group', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the Instance Boot Group', type : 'uuid', length : 255, required : True, related : 'createInstanceBootGroup,updateInstanceBootGroup,listInstanceBootGroups,startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup'}, {name : 'readinessrebootonretry', description : 'Per-boot-group override of whether an instance is rebooted between readiness retry attempts', type : 'boolean', length : 255, required : False}, {name : 'readinessinitialdelayseconds', description : 'Per-boot-group override of the global delay (seconds) after starting or rebooting an instance before its first readiness check of that attempt. Pass -1 to clear the override and fall back to the global setting', type : 'long', length : 255, required : False}, {name : 'readinessattempttimeoutseconds', description : 'Per-boot-group override of the global timeout (seconds) for each readiness retry attempt. Pass -1 to clear the override and fall back to the global setting', type : 'long', length : 255, required : False}, {name : 'description', description : 'New description for the Instance Boot Group', type : 'string', length : 255, required : False}, {name : 'readinessmaxretryattempts', description : 'Per-boot-group override of the global maximum number of readiness retry attempts. Pass -1 to clear the override and fall back to the global setting', type : 'long', length : 255, required : False}], response : [{name : 'name', description : 'The name of the instance boot group', type : 'string'}, {name : 'accountid', description : 'The account ID owning the instance boot group', type : 'string'}, {name : 'domainpath', description : 'The path of the domain the instance boot group belongs to', type : 'string'}, {name : 'id', description : 'The ID of the instance boot group', type : 'string'}, {name : 'projectid', description : 'The project ID of the instance boot group', type : 'string'}, {name : 'domain', description : 'The domain name of the instance boot group', type : 'string'}, {name : 'account', description : 'The account owning the instance boot group', type : 'string'}, {name : 'created', description : 'The date the instance boot group was created', type : 'date'}, {name : 'readinessmaxretryattempts', description : 'Effective maximum number of readiness retry attempts (per-boot-group override if set, else the global default)', type : 'long'}, {}, {name : 'domainid', description : 'The domain ID of the instance boot group', 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 : 'readinessinitialdelayseconds', description : 'Effective delay in seconds after starting or rebooting an instance before its first readiness check of that attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'project', description : 'The project name of the instance boot group', type : 'string'}, {name : 'description', description : 'The description of the instance boot group', type : 'string'}, {}, {name : 'readinessrebootonretry', description : 'Effective setting for whether an instance is rebooted between readiness retry attempts (per-boot-group override if set, else the global default)', type : 'boolean'}, {name : 'readinessattempttimeoutseconds', description : 'Effective timeout in seconds for each readiness retry attempt (per-boot-group override if set, else the global default)', type : 'long'}], 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 : 'importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume', params : [{name : 'size', description : 'New volume size in GB for the custom disk offering', type : 'long', length : 255, required : False}, {name : 'maxiops', description : 'New maximum number of IOPS for the custom disk offering', type : 'long', 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 : 'shrinkok', description : 'Verify OK to Shrink', type : 'boolean', length : 255, required : False}, {name : 'miniops', description : 'New minimum number of IOPS for the custom disk offering', type : 'long', length : 255, required : False}, {name : 'diskofferingid', description : 'New disk offering ID', type : 'uuid', length : 255, required : True, related : 'createDiskOffering,cloneDiskOffering,listDiskOfferings'}, {name : 'id', description : 'The ID of the volume', type : 'uuid', length : 255, required : True, related : 'importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}], response : [{name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {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 : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", 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 : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'vmstate', description : 'State of the Instance', type : 'string'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', 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 : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'kmskeyid', description : 'KMS key 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 : 'name', description : 'Name of the disk volume', 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 : '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 : 'account', description : 'The Account 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 : 'resourcetype', description : 'Resource type', 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 : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', 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 : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'size', description : 'Size of the disk volume', 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 : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', 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 : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'id', description : 'ID of the disk volume', type : 'string'}], httprequesttype : 'POST'}, {name : 'createProjectRole', description : 'Creates a Project role', since : '4.15.0', isasync : False, related : 'listProjectRoles,updateProjectRole', params : [{name : 'name', description : 'Creates a project role with this unique name', type : 'string', length : 255, required : True}, {name : 'description', description : 'The description of the Project role', type : 'string', length : 255, required : False}, {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 : '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'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'name', description : 'The name of the role', type : 'string'}, {}, {}, {name : 'description', description : 'The description 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 : 'createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule', params : [{name : 'endport', description : 'The ending port of Ipv6 firewall rule', type : 'integer', length : 255, required : False}, {name : 'icmpcode', description : 'Error code for this ICMP message', type : 'integer', 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 : '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 : 'icmptype', description : 'Type of the ICMP message being sent', type : 'integer', length : 255, required : False}, {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 : '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 : '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 : 'startport', description : 'The starting 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 : 'privateendport', 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 : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', type : 'string'}, {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 : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {name : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'state', description : 'The state of the rule', 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 : 'virtualmachineid', description : 'The Instance ID 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 : 'domainid', description : 'The ID of 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 : '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 : '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 : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'networkid', description : 'The ID 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'}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {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'}], httprequesttype : 'POST'}, {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 : 'type', description : 'The type of the zone (Public/Private)', type : 'zonetype'}, {name : 'domain', description : 'the name of the domain associated with the DNS zone', type : 'string'}, {name : 'name', description : 'Name of the DNS zone', 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 : '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 : 'networkid', description : 'ID of the network this zone is associated with', type : 'string'}, {name : 'description', description : 'Description for 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 : 'networkname', description : 'Name of the network this zone is associated with', type : 'string'}, {}, {name : 'id', description : 'ID of the DNS zone', type : 'string'}, {name : 'account', description : 'the account associated with the DNS zone', type : 'string'}, {name : 'state', description : 'The state of the zone (Active/Inactive)', type : 'state'}], httprequesttype : 'POST'}, {name : 'listBackups', description : 'Lists Instance backups', since : '4.14.0', isasync : False, related : 'updateBackupSchedule', 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 : 'type', description : 'list backups by type', type : 'string', length : 255, required : False, since : '24.0'}, {name : 'id', description : 'ID of the backup', type : 'uuid', length : 255, required : False, related : 'updateBackupSchedule,listBackups'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {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 : 'keyword', description : 'List by keyword', 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 : '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 : '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 : 'listvmdetails', description : 'list backups with VM details', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'zoneid', description : 'List backups by zone id', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'status', description : 'list backups by status', type : 'string', length : 255, required : False, since : '4.23.0'}, {name : 'name', description : 'list backups by name', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'fromcheckpointid', description : 'Previous active checkpoint ID for incremental backups', type : 'string'}, {name : 'validationstatus', description : 'Backup validation status.', type : 'validationstatus'}, {name : 'account', description : 'Account name', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domain', description : 'Domain name', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {name : 'domainid', description : 'Domain ID', type : 'string'}, {name : 'compressionstatus', description : 'Backup compression status.', type : 'compressionstatus'}, {name : 'backupofferingid', description : 'Backup offering id', type : 'string'}, {name : 'accountid', description : 'Account id', type : 'string'}, {name : 'backupofferingname', description : 'Backup offering name', type : 'string'}, {name : 'hostid', description : 'Host ID where the backup is running', type : 'string'}, {name : 'id', description : 'ID of the Instance backup', type : 'string'}, {name : 'volumes', description : 'Backed up volumes', type : 'string'}, {name : 'virtualsize', description : 'Backup protected (virtual) size in bytes', type : 'long'}, {name : 'type', description : 'Backup type', type : 'string'}, {name : 'uncompressedsize', description : 'Backup uncompressed size in bytes. Only defined if backup is compressed.', type : 'long'}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'externalid', description : 'External backup id', type : 'string'}, {name : 'size', description : 'Backup size in bytes', type : 'long'}, {name : 'status', description : 'Backup status', type : 'status'}, {name : 'isbackupvmexpunged', description : 'Indicates whether the VM from which the backup was taken is expunged or not', type : 'boolean'}, {}, {name : 'vmdetails', description : 'Lists the vm specific details for the backup', type : 'map'}, {name : 'description', description : 'description for the backup', type : 'string'}, {name : 'tocheckpointid', description : 'Next checkpoint ID for incremental backups', type : 'string'}, {name : 'vmbackupofferingremoved', description : 'The backup offering corresponding to this backup was removed from the VM', type : 'boolean'}, {name : 'created', description : 'Backup date', type : 'date'}, {name : 'intervaltype', description : 'Interval type of the backup', type : 'string'}, {name : 'zone', description : 'Zone name', type : 'string'}, {}, {name : 'name', description : 'name of the backup', type : 'string'}], httprequesttype : 'GET'}, {name : 'setupUserTwoFactorAuthentication', description : 'Setup the 2FA for the user.', since : '4.18.0', isasync : False, related : '', params : [{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}, {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'}], response : [{name : 'username', description : 'The user name', type : 'string'}, {}, {name : 'id', description : 'The user ID', type : 'string'}, {name : 'secretcode', description : 'Secret code that needs to be registered with authenticator', 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 : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,listWebhooks,updateWebhook,listWebhookDeliveries,addWebhookFilter'}, {name : 'id', description : 'The ID of the Webhook filter', type : 'uuid', length : 255, required : False, related : 'listWebhookFilters'}], 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 : 'createDnsZone', description : 'Creates a new DNS Zone on a specific server', since : '4.23.0', isasync : True, related : 'listDnsZones', params : [{name : 'name', description : 'The name of the DNS zone (e.g. example.com)', type : 'string', length : 255, required : True}, {name : 'type', description : 'The type of zone (Public, Private). Defaults to Public.', type : 'string', length : 255, required : False}, {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}, {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'}], response : [{name : 'type', description : 'The type of the zone (Public/Private)', type : 'zonetype'}, {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 : 'dnsserveraccount', description : 'the account name of the DNS server owner', 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 zone (Active/Inactive)', type : 'state'}, {name : 'dnsserverid', description : 'ID of the DNS server this zone belongs to', type : 'string'}, {name : 'domain', description : 'the name of the domain associated with the DNS zone', type : 'string'}, {name : 'name', description : 'Name of the DNS zone', type : 'string'}, {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 : 'dnsservername', description : 'the name of the DNS server hosting this zone', type : 'string'}, {name : 'description', description : 'Description for the DNS zone', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the DNS server', type : 'string'}, {name : 'account', description : 'the account associated with 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 : '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 : 'listWebhooks', description : 'Lists Webhooks', since : '4.20.0', isasync : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries,addWebhookFilter', params : [{name : 'state', description : 'The state of the Webhook', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'scope', description : 'The scope of the Webhook', type : 'string', length : 255, required : False}, {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 : '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 Webhook', 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 : 'id', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,listWebhooks,updateWebhook,listWebhookDeliveries,addWebhookFilter'}, {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,moveDomain'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}], response : [{name : 'projectid', description : 'the project id of the Kubernetes cluster', type : 'string'}, {}, {name : 'account', description : 'The account associated with the Webhook', 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 : 'name', description : 'The name 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 : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'description', description : 'The description of 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', type : 'string'}, {name : 'created', description : 'The date when this Webhook was created', type : 'date'}, {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 : '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 : 'pagesize', description : '', type : 'integer', 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 : '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'}], response : [{name : 'name', description : 'the name of the VM', type : 'string'}, {name : 'id', description : 'the ID of the VM', type : 'string'}, {name : 'clustername', description : 'the cluster name for the VM', type : 'string'}, {name : 'clusterid', description : 'the cluster ID for the VM', type : 'string'}, {name : 'hostname', description : 'the hostname for the VM', 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 : 'hostid', description : 'the host ID for 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 : 'payloadurl', description : 'Payload URL of the Webhook delivery', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the Webhook delivery for redelivery', type : 'uuid', length : 255, required : False, related : 'executeWebhookDelivery'}, {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 : '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 : 'payload', description : 'Payload of the Webhook delivery', type : 'string', length : 255, required : False}], response : [{name : 'headers', description : 'The headers of the webhook delivery', type : 'string'}, {name : 'startdate', description : 'The start time of the Webhook delivery', type : 'date'}, {name : 'enddate', description : 'The end time of the Webhook delivery', type : 'date'}, {name : 'response', description : 'The response of the webhook delivery', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', 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 : 'eventtype', description : 'The type of the event', type : 'string'}, {}, {}, {name : 'payload', description : 'The payload of the webhook delivery', type : 'string'}, {name : 'managementserverid', description : 'The ID of the management server which executed delivery', type : 'string'}, {name : 'webhookname', description : 'The name of the Webhook', type : 'string'}, {name : 'success', description : 'Whether Webhook delivery succeeded or not', type : 'boolean'}, {name : 'id', description : 'The ID of the Webhook delivery', type : 'string'}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'updateAutoScaleVmGroup', description : 'Updates an existing autoscale Instance group.', isasync : True, related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups', params : [{name : 'name', description : 'The name of the autoscale vmgroup', type : 'string', length : 255, required : False, since : '4.18.0'}, {name : 'id', description : 'The ID of the autoscale group', type : 'uuid', length : 255, required : True, related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup'}, {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 : 'scaleuppolicyids', description : 'List of scaleup 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 : 'scaledownpolicyids', description : 'List of scaledown autoscale policies', type : 'list', length : 255, required : False, related : 'listAutoScalePolicies,updateAutoScalePolicy'}, {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'}], response : [{name : 'project', description : 'The project name of the Instance group', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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 : 'lbprovider', description : 'The LB provider of the guest Network the LB rule belongs to', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {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 : 'created', description : 'The date when this Instance group was created', type : 'date'}, {name : 'privateport', description : 'The private port', 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 : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {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 : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {name : 'state', description : 'The current state of the AutoScale Instance Group', type : 'string'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'projectid', description : 'The project id of the Instance group', type : 'string'}, {name : 'publicport', description : 'The public 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 : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {name : 'associatednetworkid', description : 'The id 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'}], 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 : '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 : 'serviceofferingid', description : 'List by the service offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'arch', description : 'CPU arch of the 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, related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}, {name : 'keyword', description : 'List by keyword', type : 'string', 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 : 'page', description : '', type : 'integer', 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 : 'createExtension,listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension'}, {name : 'podid', description : 'The pod ID', type : 'uuid', length : 255, required : False, related : 'createPod,listPods,updatePod,createManagementNetworkIpRange'}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", type : 'boolean', 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 : 'keypair', description : 'List Instances by SSH keypair name', type : 'string', 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 : '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 : 'userdataid', description : 'the instances by userdata', type : 'uuid', length : 255, required : False, since : '4.20.1', related : 'listCniConfiguration'}, {name : 'hostid', description : 'The host ID', type : 'uuid', length : 255, required : False, related : 'addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost'}, {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 : 'forvirtualnetwork', description : 'List by Network type; true if need to list Instances using Virtual Network, false otherwise', type : 'boolean', length : 255, required : False}, {name : 'groupid', description : 'The group ID', type : 'uuid', length : 255, required : False, related : 'createInstanceGroup,updateInstanceGroup'}, {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 : 'showicon', description : 'Flag to display the resource icon for Instances', type : 'boolean', length : 255, required : False, since : '4.16.0.0'}, {name : 'affinitygroupid', description : 'List Instances by affinity group', type : 'uuid', length : 255, required : False, related : 'createAffinityGroup,listAffinityGroups'}, {name : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'hypervisor', description : 'The target hypervisor for the Template', 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 : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', 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 : '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 : 'vpcid', description : 'List Instances by VPC', type : 'uuid', length : 255, required : False, related : 'listVPCs,createVPC,listVPCs,updateVPC,migrateVPC'}, {name : 'isoid', description : 'List Instances by ISO', type : 'uuid', 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 : '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 : '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 : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {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 : '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 : '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 : 'backupofferingid', description : 'List by the backup offering', type : 'uuid', length : 255, required : False, since : '4.17', related : 'listBackupProviderOfferings,importBackupOffering,cloneBackupOffering,listBackupOfferings,updateBackupOffering,createBackupOffering'}, {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 : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', 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 : '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'}], response : [{name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'groupid', description : 'The group ID of 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 : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'zoneid', description : 'The ID 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 : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'isolationuri', description : 'The isolation URI of the NIC', 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 : '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 : 'id', description : 'The ID of the NIC', type : 'string'}, {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 : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', 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 : 'gateway', description : 'The gateway of the NIC', 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 : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', 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 : '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 : 'type', description : 'The type of the NIC', type : 'string'}, {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 : 'isdefault', description : 'True if NIC is default, false otherwise', 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 : 'projectid', description : 'The project ID 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 : 'domainpath', description : 'Path of the domain in which the virtual machine exists', 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 : 'arch', description : 'CPU arch of the VM', type : 'string'}, {}, {name : 'hostid', description : 'The ID of the host 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 : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {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 : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', 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 : '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 : '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 : '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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', 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 : 'key', description : 'Tag key name', 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 : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}]}, {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 : '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 : 'ruleid', description : 'The ID 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 : '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 : '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 : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', 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 : '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 : '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 : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'name', description : 'The name of the security group', 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 : '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 : '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 : 'projectid', description : 'The project ID the 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 : 'domainid', description : 'The ID 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 : 'resourceid', description : 'ID of the resource', 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 : 'account', description : 'The Account owning 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 : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {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 : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'domain', description : 'The name 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 : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering 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 : '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 : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile 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 : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {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 : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'state', description : 'The state of the Instance', 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 : 'virtualmachineIds', description : 'Instance IDs 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 : 'id', description : 'The ID of 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 : 'account', description : 'The account owning 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 : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}]}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {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 : '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 : '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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', 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 : 'value', description : 'Tag value', type : 'string'}]}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', 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 : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read 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 : '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 : '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 : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {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 : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {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 : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'userid', description : "The User's ID who deployed 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'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}], httprequesttype : 'GET'}, {name : 'listInstanceBootGroups', description : 'Lists Instance Boot Groups', since : '24.0', isasync : False, related : 'createInstanceBootGroup,startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup', params : [{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 : '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 : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'instancegroupid', description : 'List Instance Boot Groups that contain the Instance Group', type : 'uuid', length : 255, required : False, related : 'createInstanceGroup,updateInstanceGroup'}, {name : 'virtualmachineid', description : 'List Instance Boot Groups that contain the Instance', type : 'uuid', length : 255, required : 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'}, {name : 'keyword', description : 'List Instance Boot Groups by name keyword', 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 : '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 : 'id', description : 'List Instance Boot Group by ID', type : 'uuid', length : 255, required : False, related : 'createInstanceBootGroup,listInstanceBootGroups,startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup'}], response : [{name : 'domain', description : 'The domain name of the instance boot group', type : 'string'}, {name : 'name', description : 'The name of the instance boot group', type : 'string'}, {name : 'id', description : 'The ID of the instance boot group', type : 'string'}, {name : 'accountid', description : 'The account ID owning the instance boot group', type : 'string'}, {}, {name : 'projectid', description : 'The project ID of the instance boot group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the instance boot group', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'readinessrebootonretry', description : 'Effective setting for whether an instance is rebooted between readiness retry attempts (per-boot-group override if set, else the global default)', type : 'boolean'}, {name : 'project', description : 'The project name of the instance boot group', type : 'string'}, {name : 'created', description : 'The date the instance boot group was created', type : 'date'}, {name : 'account', description : 'The account owning the instance boot group', type : 'string'}, {}, {name : 'domainpath', description : 'The path of the domain the instance boot group belongs to', type : 'string'}, {name : 'description', description : 'The description of the instance boot group', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'readinessinitialdelayseconds', description : 'Effective delay in seconds after starting or rebooting an instance before its first readiness check of that attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'readinessattempttimeoutseconds', description : 'Effective timeout in seconds for each readiness retry attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'readinessmaxretryattempts', description : 'Effective maximum number of readiness retry attempts (per-boot-group override if set, else the global default)', type : 'long'}], 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 : '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 : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {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 : '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 : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'memory', description : 'The memory 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 : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'state', description : 'The state of the Kubernetes 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 : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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 : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {}, {name : 'workerofferingname', description : 'the name of the service offering of the worker 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 : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'name', description : 'The name 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 : '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 : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', 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 : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}], 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 : 'created', description : 'The date when this Instance was created', type : 'date'}, {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 : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {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 : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', 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 : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', 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 : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', 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 : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'netmask', description : 'The netmask of the NIC', 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 : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', 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 : '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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {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 : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {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 : '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 : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {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 : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', 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 : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', 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 : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}]}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{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 : 'resourcetype', description : 'Resource type', 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 : '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 : 'domain', description : 'The domain associated with the tag', type : 'string'}]}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', 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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', 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 : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance 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 : 'deleteprotection', description : 'true if vm has delete protection.', 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 : 'description', description : 'The description of the affinity group', type : 'string'}, {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 : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning 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 : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}]}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {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 : 'protocol', description : 'The protocol of the security group rule', 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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', 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 : 'key', description : 'Tag key name', 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 : 'account', description : 'The Account 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 : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', 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 : 'icmptype', description : 'The type of the ICMP message response', 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 : '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 : '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 : '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 : 'customer', description : 'Customer associated with the tag', type : 'string'}, {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 : '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 : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {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 : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'securitygroupname', description : 'Security group name', 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 : '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 : '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 : '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 : '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 : '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 : 'value', description : 'Tag value', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}]}, {name : 'project', description : 'The project name of the group', type : 'string'}]}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', 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 : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {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 : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {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 : '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 : '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 : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'password', description : 'The password (if exists) of the Instance', 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 : '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 : '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 : 'webhookid', description : 'ID for the Webhook', type : 'uuid', length : 255, required : True, related : 'createWebhook,updateWebhook,listWebhookDeliveries,addWebhookFilter'}, {name : 'matchtype', description : 'Match type for the Webhook filter - Exact, Prefix, Suffix or Contains', type : 'string', length : 255, required : False}, {name : 'value', description : 'Value for the Webhook which that will be matched', 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 : '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 : 'domain', description : 'The name of the domain in which the Webhook exists', 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 : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {name : 'projectid', description : 'the project id of the Kubernetes cluster', type : 'string'}, {name : 'secretkey', description : 'The secret key for the Webhook', type : 'string'}, {}, {name : 'domainid', description : 'The ID of the domain in which the Webhook exists', type : 'string'}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {}, {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 : 'created', description : 'The date when this Webhook was created', type : 'date'}, {name : 'description', description : 'The description of the Webhook', type : 'string'}, {name : 'id', description : 'The ID of the Webhook', type : 'string'}], 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 : 'name', description : 'the name of the protocol parameter', type : 'string'}, {name : 'details', description : 'the details of the protocol parameter', type : 'map'}, {}, {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 : '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'}], httprequesttype : 'GET'}, {name : 'listGuiThemes', description : 'Lists GUI themes.', since : '4.21.0.0', isasync : False, related : 'createGuiTheme', params : [{name : 'name', description : 'The name of the theme.', type : 'string', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'listall', description : 'Whether to list all 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 : 'page', description : '', type : 'integer', 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 : 'pagesize', 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 : 'showremoved', description : 'Whether to list removed themes.', type : 'boolean', length : 255, required : False}, {name : 'listonlydefaulttheme', description : 'Whether to only list the default theme.', type : 'boolean', length : 255, required : False}], response : [{name : 'id', description : 'ID of the custom GUI theme.', type : 'string'}, {}, {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'}, {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 : '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 : '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 : 'description', description : 'Description of the GUI theme.', type : 'string'}, {name : 'name', description : 'Name of the GUI 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 : '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 : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {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 : 'removed', description : 'When the GUI theme was removed.', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'recursivedomains', description : 'Whether to consider the subdomains of the informed domain IDs.', 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 : 'account', description : 'An optional account for the userdata. Must be used with domainId.', type : 'string', length : 255, required : False}, {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 : 'projectid', description : 'An optional project for the userdata', type : 'uuid', length : 255, required : False, related : 'activateProject,createProject,suspendProject,updateProject'}], 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 : 'updateInstanceBootGroupMember', description : 'Updates the boot order of a member in an instance boot group', since : '24.0', isasync : False, related : 'addMemberToInstanceBootGroup,listInstanceBootGroupMembers', params : [{name : 'order', description : 'The new boot order value (0 or greater)', type : 'integer', length : 255, required : True}, {name : 'id', description : 'The ID of the boot group member entry', type : 'uuid', length : 255, required : True, related : 'addMemberToInstanceBootGroup,updateInstanceBootGroupMember,listInstanceBootGroupMembers'}], response : [{name : 'order', description : 'The boot order value for this member', type : 'int'}, {name : 'memberid', description : 'The ID of the VM or InstanceGroup', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'membername', description : 'The name of the VM or InstanceGroup', type : 'string'}, {name : 'created', description : 'The date the member was added to the boot group', type : 'date'}, {name : 'readinessmessage', description : "Why readinessstatus is what it is: the failing rule(s)' cached message, and/or a count of not-ready member VMs for InstanceGroup members", type : 'string'}, {name : 'readinessstatus', description : 'The last cached readiness evaluation', type : 'string'}, {}, {name : 'id', description : 'The UUID of this member entry', type : 'string'}, {name : 'bootgroupid', description : 'The ID of the boot group this member belongs to', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'memberstate', description : 'The state of the Instance', type : 'string'}, {name : 'membertype', description : 'The type of the member: VirtualMachine or InstanceGroup', type : 'string'}, {name : 'readinessmode', description : 'None, CHILD_DEPENDENT or RULE_BASED, computed from whether readiness rules are attached', type : 'string'}, {name : 'children', description : 'For InstanceGroup members, the VMs within the group (only present when requested via details=children)', type : 'list'}], httprequesttype : 'POST'}, {name : 'listVmwareDcs', description : 'Retrieves VMware DC(s) associated with a zone.', isasync : False, related : 'addVmwareDc', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {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 : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'vcenter', description : 'The VMware vCenter name/ip', type : 'string'}, {name : 'id', description : 'The VMware Datacenter ID', type : 'string'}, {name : 'name', description : 'The VMware Datacenter name', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'zoneid', description : 'The Zone ID associated with this VMware Datacenter', type : 'long'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'deleteBackupSchedule', description : 'Deletes the backup schedule of a Instance', since : '4.14.0', isasync : False, params : [{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'}, {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'}], 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 : 'listResourceSchedule', description : 'List Resource Schedules', since : '4.23.0', isasync : False, related : 'updateResourceSchedule', params : [{name : 'action', description : 'Action to take on the resource.', type : 'string', length : 255, required : False}, {name : 'enabled', description : 'Filter by enabled status.', type : 'boolean', length : 255, required : False}, {name : 'resourcetype', description : 'Type of the resource.', type : 'string', length : 255, required : True}, {name : 'resourceid', description : 'ID of the resource for which schedules are to be listed.', 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 : '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 : 'id', description : 'ID of the schedule', type : 'uuid', length : 255, required : False, related : 'listResourceSchedule,updateResourceSchedule'}], response : [{name : 'schedule', description : 'Cron formatted resource schedule', type : 'string'}, {name : 'enabled', description : 'Resource schedule is enabled', type : 'boolean'}, {name : 'id', description : 'The ID of resource schedule', type : 'string'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'description', description : 'Description of resource schedule', type : 'string'}, {name : 'action', description : 'Action', type : 'action'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'resourcetype', description : 'Type of the resource', type : 'apicommandresourcetype'}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {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 : 'details', description : 'Schedule details', type : 'map'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}], httprequesttype : 'GET'}, {name : 'listVolumesUsageHistory', description : 'Lists volume stats', since : '4.18.0', isasync : False, related : '', params : [{name : 'pagesize', description : '', type : 'integer', 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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the volume.', type : 'uuid', length : 255, required : False, related : 'importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}, {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 : 'ids', description : 'the IDs of the Volumes, mutually exclusive with id.', type : 'list', length : 255, required : False, related : 'importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}, {name : 'startdate', description : 'Start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}], response : [{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'}, {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 : 'id', description : 'The ID of the volume', type : 'string'}, {}], httprequesttype : 'GET'}, {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 : '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 : 'createProjectRolePermission', description : 'Adds API permissions to a project role', since : '4.15.0', isasync : False, related : 'listProjectRolePermissions', params : [{name : 'description', description : 'The description of the role permission', type : 'string', length : 255, required : False}, {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 : 'projectid', description : 'ID of project where project role permission is to be created', 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'}], response : [{name : 'rule', description : 'The api name or wildcard rule', type : 'string'}, {name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'description', description : 'The description of the role permission', type : 'string'}, {name : 'id', description : 'The ID of the project role permission', 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 : 'permission', description : 'The permission type of the api name or wildcard rule, allow/deny', type : 'string'}, {name : 'projectroleid', description : 'The ID of the project role to which the role permission belongs', type : 'string'}, {name : 'projectrolename', description : 'The name of the project role to which the role permission belongs', type : 'string'}, {}, {}], httprequesttype : 'POST'}, {name : 'createConsoleEndpoint', description : 'Create a console endpoint to connect to a Instance console', since : '4.18.0', isasync : False, related : '', params : [{name : 'token', description : '(optional) extra security token, valid when the extra validation is enabled', type : 'string', length : 255, required : False}, {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'}], 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 : 'websocket', description : 'The console websocket options', type : 'consoleendpointwebsocketresponse'}, {name : 'details', description : 'Details in case of an error', type : 'string'}, {}, {name : 'url', description : 'The console url', type : 'string'}, {}, {name : 'success', description : 'True if the console endpoint is generated properly', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'updateProjectRolePermission', description : 'Updates a project role permission and/or order', since : '4.15.0', isasync : False, params : [{name : 'permission', description : 'Rule permission, can be: allow or deny', type : 'string', length : 255, required : False}, {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 : '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'}], 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 : 'addUserToProject', description : 'Adds User to a project', since : '4.14', isasync : True, params : [{name : 'projectroleid', description : 'ID of the project role', type : 'uuid', length : 255, required : False, related : 'listProjectRoles,updateProjectRole'}, {name : 'roletype', description : 'Project role type to be assigned to the User - Admin/Regular', 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 : 'username', description : 'Name of the User to be added to the project', type : 'string', length : 255, required : True}, {name : 'email', description : 'Email ID of User to which invitation to the project is going to be sent', type : 'string', 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 : '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 : '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 : '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 : 'listWebhookFilters', description : 'Lists Webhook filters', since : '4.23.0', isasync : False, related : '', params : [{name : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries'}, {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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', 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 : '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 : 'type', description : 'The type of the Webhook filter', type : 'string'}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'string'}, {name : 'mode', description : 'The type of the Webhook filter', type : 'string'}, {name : 'webhookname', description : 'The name of the Webhook', type : 'string'}, {name : 'matchtype', description : 'The type of the Webhook filter', type : 'string'}, {}, {name : 'value', description : 'The type of the Webhook filter', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateCondition', description : 'Updates a condition for Instance auto scaling', since : '4.18.0', isasync : True, params : [{name : 'threshold', description : 'Value for which the Counter will be evaluated with the Operator selected.', type : 'long', length : 255, required : True}, {name : 'id', description : 'The ID of the condition.', type : 'uuid', length : 255, required : True, related : 'listConditions'}, {name : 'relationaloperator', description : 'Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.', 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 : '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 : 'cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost'}, {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'}, {name : 'virtualmachineid', description : 'The ID of the Instance', type : 'uuid', length : 255, required : True, related : 'migrateSystemVm,startSystemVm,changeServiceForSystemVm'}, {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'}], response : [{name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', 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 : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', 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 : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {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 : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'deleteInstanceBootGroupReadinessRule', description : 'Deletes an Instance Boot Group readiness rule', since : '24.0', isasync : False, params : [{name : 'id', description : 'The ID of the Instance Boot Group readiness rule', type : 'uuid', length : 255, required : True, related : 'createInstanceBootGroupReadinessRule,updateInstanceBootGroupReadinessRule'}], 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 : 'createRoutingFirewallRule', description : 'Creates a routing firewall rule in the given network in ROUTED mode', since : '4.20.0', isasync : True, related : 'listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule', params : [{name : 'endport', description : 'the ending 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 : '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 : '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}, {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 : '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 : 'fordisplay', description : 'an optional field, whether to the display the rule to the end user or not', type : 'boolean', length : 255, required : False}, {name : 'startport', description : 'the starting port of firewall rule', type : 'integer', length : 255, required : False}], response : [{name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {name : 'id', description : 'The ID of the port forwarding rule', 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 : '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 : 'domainpath', description : 'Path 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 : '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 : '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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {}, {name : 'privateport', description : "The starting port of port forwarding rule's private port range", 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 : 'virtualmachineid', description : 'The Instance ID for the port forwarding rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name 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 : '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 : 'virtualmachinedisplayname', description : 'The Instance display name 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 : 'publicport', description : "The starting port of port forwarding rule's public 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'}], 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'accountid', description : 'The ID of Account the Network is available for', type : 'string'}, {name : 'projectid', description : 'The ID of project the Network is available for', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'networkid', description : 'The Network ID', type : 'string'}, {name : 'domain', description : 'The name of the domain to which the Network belongs', type : 'string'}, {}, {name : 'domainid', description : 'The ID of the domain to which the Network belongs', type : 'string'}, {name : 'account', description : 'The Account the Network is available for', type : 'string'}, {name : 'project', description : 'The project the Network is available for', type : 'string'}], 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 : '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 : 'updateResourceSchedule', description : 'Update Resource Schedule', since : '4.23.0', isasync : False, related : '', params : [{name : 'description', description : 'Description of the schedule', type : 'string', length : 255, required : False}, {name : 'id', description : 'ID of the schedule to be updated', type : 'uuid', length : 255, required : True, related : 'updateResourceSchedule'}, {name : 'enddate', description : 'End date after which the schedule becomes inactive.', type : 'date', length : 255, required : False}, {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 : 'startdate', description : 'Start date from which the schedule becomes active.', type : 'date', 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}], response : [{name : 'resourceid', description : 'ID of the resource', type : 'string'}, {}, {}, {name : 'enabled', description : 'Resource schedule is enabled', type : 'boolean'}, {name : 'details', description : 'Schedule details', type : 'map'}, {name : 'action', description : 'Action', type : 'action'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'description', description : 'Description of resource schedule', type : 'string'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {name : 'id', description : 'The ID of resource schedule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'resourcetype', description : 'Type of the resource', type : 'apicommandresourcetype'}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'schedule', description : 'Cron formatted resource schedule', type : 'string'}], httprequesttype : 'POST'}, {name : 'startVmwareCbtMigration', description : 'Start tracking a VMware CBT based migration session', since : '4.24.0', isasync : True, related : 'listVmwareCbtMigrations,syncVmwareCbtMigration,cutoverVmwareCbtMigration,cancelVmwareCbtMigration', params : [{name : 'clustername', description : 'the source VMware cluster name', type : 'string', length : 255, required : False}, {name : 'serviceofferingid', description : 'the service offering for the migrated VM', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'displayname', description : 'the display name of the migrated VM', type : 'string', length : 255, required : False}, {name : 'forced', description : 'import despite duplicate NIC MAC addresses; CloudStack generates a new MAC address when a duplicate exists', type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'import the migrated VM to the specified domain', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'projectid', description : 'import the migrated VM for the project', type : 'uuid', length : 255, required : False, related : 'activateProject,createProject,suspendProject'}, {name : 'existingvcenterid', description : 'UUID of a linked existing vCenter', type : 'uuid', length : 255, required : False, related : 'addVmwareDc'}, {name : 'hostname', description : 'the host name of the migrated VM', type : 'string', length : 255, required : False}, {name : 'convertinstancepoolid', description : 'optional primary storage pool for converted disks', type : 'uuid', length : 255, required : False, related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}, {name : 'nicipaddresslist', description : 'VM NIC to ip address mapping using keys NIC, ip4Address', type : 'map', length : 255, required : False}, {name : 'zoneid', description : 'the destination zone ID', type : 'uuid', length : 255, required : True, related : 'createZone,listZones'}, {name : 'details', description : 'optional migration details, including VDDK settings such as vddk.lib.dir, vddk.transports and vddk.thumbprint', type : 'map', length : 255, required : False}, {name : 'datadiskofferinglist', description : 'datadisk to disk-offering mapping using keys disk and diskOffering', type : 'map', length : 255, required : False}, {name : 'convertinstancehostid', description : 'optional KVM host to perform virt-v2v conversion and CBT block replication', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost'}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'uuid', length : 255, required : True, related : 'addCluster,updateCluster'}, {name : 'nicnetworklist', description : 'VM NIC to network id mapping using keys NIC and network', type : 'map', length : 255, required : False}, {name : 'password', description : 'the password for the source vCenter', type : 'string', length : 255, required : False}, {name : 'hostip', description : 'the source VMware ESXi host IP address or FQDN', type : 'string', length : 255, required : False}, {name : 'vcenter', description : 'the source vCenter IP address or FQDN', type : 'string', length : 255, required : False}, {name : 'username', description : 'the username for the source vCenter', type : 'string', length : 255, required : False}, {name : 'datacentername', description : 'the source VMware datacenter name', type : 'string', length : 255, required : False}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string', length : 255, required : True}, {name : 'account', description : 'optional account for the migrated VM. Must be used with domainid', type : 'string', length : 255, required : False}, {name : 'osid', description : 'optional guest OS ID for the migrated VM', type : 'uuid', length : 255, required : False, related : 'addGuestOs'}, {name : 'templateid', description : 'the template ID for the migrated VM', 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'}], response : [{name : 'completedcycles', description : 'the number of completed CBT delta cycles', type : 'int'}, {name : 'cycle', description : 'the CBT delta synchronization cycles tracked by this VMware CBT migration', type : 'list'}, {name : 'zoneid', description : 'the destination zone ID', type : 'string'}, {name : 'zonename', description : 'the destination zone name', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'virtualmachineid', description : 'the ID of the imported VM after cutover', type : 'string'}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string'}, {name : 'convertinstancehostname', description : 'the KVM host name selected for conversion and CBT replication', type : 'string'}, {name : 'displayname', description : 'the display name of the target VM', type : 'string'}, {name : 'poolname', description : 'the storage pool name selected for converted disks', type : 'string'}, {name : 'accountid', description : 'the account ID', type : 'string'}, {name : 'convertinstancehostid', description : 'the KVM host selected for conversion and CBT replication', type : 'string'}, {}, {name : 'sourcehost', description : 'the source VMware ESXi host', type : 'string'}, {name : 'lasterror', description : 'the last migration error', type : 'string'}, {name : 'lastupdated', description : 'the last updated date of the VMware CBT migration', type : 'date'}, {name : 'quietcycles', description : 'the number of consecutive quiet CBT delta cycles', type : 'int'}, {name : 'vcenter', description : 'the source VMware vCenter', type : 'string'}, {name : 'state', description : 'the migration state', type : 'string'}, {name : 'currentstepduration', description : 'the elapsed time spent in the current migration step', type : 'string'}, {name : 'created', description : 'the create date of the VMware CBT migration', type : 'date'}, {name : 'existingvcenterid', description : 'the linked existing vCenter ID, when used', type : 'string'}, {name : 'currentstep', description : 'the current migration step', type : 'string'}, {name : 'lastdirtyrate', description : 'the dirty rate in bytes per second observed in the last CBT delta cycle', type : 'long'}, {name : 'convertinstancepoolid', description : 'the storage pool selected for converted disks', type : 'string'}, {name : 'id', description : 'the ID of the VMware CBT migration', type : 'string'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'clustername', description : 'the destination KVM cluster name', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'datacentername', description : 'the source VMware datacenter', type : 'string'}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'string'}, {name : 'sourcecluster', description : 'the source VMware cluster', type : 'string'}, {name : 'disk', description : 'the source and target disks tracked by this VMware CBT migration', type : 'list'}, {}, {name : 'lastchangedbytes', description : 'the changed bytes observed in the last CBT delta cycle', type : 'long'}, {name : 'totalchangedbytes', description : 'the total changed bytes synchronized across CBT delta cycles', type : 'long'}], httprequesttype : 'POST'}, {name : 'listWebhookDeliveries', description : 'Lists Webhook deliveries', since : '4.20.0', isasync : False, related : 'createWebhook,updateWebhook', 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 listed.', type : 'date', length : 255, required : False}, {name : 'eventtype', description : 'The event type of the Webhook delivery', type : 'string', length : 255, required : False}, {name : 'managementserverid', description : 'The ID of the management server', type : 'uuid', length : 255, required : False, related : 'listManagementServers'}, {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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries'}, {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 : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'created', description : 'The date when this Webhook was created', type : 'date'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'projectid', description : 'the project id of the Kubernetes cluster', 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {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 : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}, {name : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {name : 'id', description : 'The ID 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 : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {name : 'description', description : 'The description of the Webhook', type : 'string'}], httprequesttype : 'GET'}, {name : 'createInstanceBootGroup', description : 'Creates an Instance Boot Group', since : '24.0', isasync : False, related : 'startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup', params : [{name : 'readinessinitialdelayseconds', description : 'Per-boot-group override of the global delay (seconds) after starting or rebooting an instance before its first readiness check of that attempt', type : 'long', length : 255, required : False}, {name : 'projectid', description : 'The project of the Instance Boot Group', type : 'uuid', length : 255, required : False, related : 'activateProject,createProject,suspendProject'}, {name : 'readinessattempttimeoutseconds', description : 'Per-boot-group override of the global timeout (seconds) for each readiness retry attempt', type : 'long', length : 255, required : False}, {name : 'name', description : 'The name of the Instance Boot Group', type : 'string', length : 255, required : True}, {name : 'description', description : 'The description of the Instance Boot Group', type : 'string', length : 255, required : False}, {name : 'account', description : 'The account of the Instance Boot Group. Must be used with domainid', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'The domain ID of the account owning the Instance Boot Group', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'readinessrebootonretry', description : 'Per-boot-group override of whether an instance is rebooted between readiness retry attempts', type : 'boolean', length : 255, required : False}, {name : 'readinessmaxretryattempts', description : 'Per-boot-group override of the global maximum number of readiness retry attempts', type : 'long', length : 255, required : False}], response : [{name : 'account', description : 'The account owning the instance boot group', type : 'string'}, {name : 'readinessmaxretryattempts', description : 'Effective maximum number of readiness retry attempts (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'domainpath', description : 'The path of the domain the instance boot group belongs to', type : 'string'}, {name : 'name', description : 'The name of the instance boot group', 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 ID of the instance boot group', type : 'string'}, {name : 'readinessinitialdelayseconds', description : 'Effective delay in seconds after starting or rebooting an instance before its first readiness check of that attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'project', description : 'The project name of the instance boot group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the instance boot group', type : 'string'}, {name : 'accountid', description : 'The account ID owning the instance boot group', type : 'string'}, {name : 'created', description : 'The date the instance boot group was created', type : 'date'}, {}, {name : 'readinessrebootonretry', description : 'Effective setting for whether an instance is rebooted between readiness retry attempts (per-boot-group override if set, else the global default)', type : 'boolean'}, {}, {name : 'description', description : 'The description of the instance boot group', type : 'string'}, {name : 'readinessattempttimeoutseconds', description : 'Effective timeout in seconds for each readiness retry attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'projectid', description : 'The project ID of the instance boot group', type : 'string'}, {name : 'domain', description : 'The domain name of the instance boot group', type : 'string'}], httprequesttype : 'POST'}, {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 : '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 : 'addVmwareDc', description : 'Adds a VMware datacenter to specified zone', isasync : False, related : '', params : [{name : 'username', description : 'The Username required to connect to resource.', type : 'string', length : 255, required : False}, {name : 'name', description : 'Name of VMware datacenter to be added to specified zone.', type : 'string', length : 255, required : True}, {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 : 'password', description : 'The password for specified username.', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'The Zone ID.', type : 'uuid', length : 255, required : True, related : 'createZone,listZones'}], response : [{name : 'id', description : 'The VMware Datacenter ID', type : 'string'}, {name : 'name', description : 'The VMware Datacenter name', type : 'string'}, {}, {name : 'zoneid', description : 'The Zone ID associated with this VMware Datacenter', type : 'long'}, {name : 'vcenter', description : 'The VMware vCenter name/ip', 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 : 'updateIpv6FirewallRule', description : 'Updates Ipv6 firewall rule with specified ID', isasync : True, related : 'listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule', params : [{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}, {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 : '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 Ipv6 firewall rule to the end User or not', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'icmpcode', description : 'Error code for this ICMP message', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the IPv6 firewall rule', type : 'uuid', length : 255, required : True, related : 'listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule'}, {name : 'icmptype', description : 'Type of the ICMP message being sent', type : 'integer', length : 255, required : False}, {name : 'endport', description : 'The ending port of Ipv6 firewall rule', type : 'integer', length : 255, required : False}, {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 : 'startport', description : 'The starting 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 : 'publicport', description : "The starting port of port forwarding rule's public 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 : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'key', description : 'Tag key name', 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 : '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 : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {}, {name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {name : 'virtualmachinedisplayname', description : 'The Instance display name for the port forwarding rule', type : 'string'}, {name : 'privateendport', 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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 : '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 : '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 : 'networkname', description : 'The Name 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 : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name for 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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'}], httprequesttype : 'GET'}, {name : 'removeInstanceBootGroupMember', description : 'Removes a member from an Instance Boot Group', since : '24.0', isasync : False, params : [{name : 'id', description : 'The ID of the Instance Boot Group member to remove', type : 'uuid', length : 255, required : True, related : 'addMemberToInstanceBootGroup,listInstanceBootGroupMembers'}], 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 : 'listAutoScaleVmGroups', description : 'Lists autoscale Instance groups.', isasync : False, related : 'enableAutoScaleVmGroup', 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 : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', 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 : 'policyid', description : 'The ID of the policy', type : 'uuid', length : 255, required : False, related : 'listAutoScalePolicies'}, {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 : 'activateProject,createProject'}, {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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'id', description : 'The ID of the autoscale Instance group', type : 'uuid', length : 255, required : False, related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups'}, {name : 'vmprofileid', description : 'The ID of the profile', type : 'uuid', length : 255, required : False, related : 'createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile'}, {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,listDomains,listDomains,moveDomain'}], response : [{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 : 'projectid', description : 'The project 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 : '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 : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'domain', description : 'The domain name of the 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 : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {}, {name : 'publicip', description : 'The public IP address', type : 'string'}, {name : 'project', description : 'The project name of the Instance group', type : 'string'}, {name : 'privateport', description : 'The private port', type : 'string'}, {name : 'lbruleid', description : 'The Load balancer rule ID', 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 : 'domainpath', description : 'path of the domain to which the vm group belongs', type : 'string'}, {name : 'publicport', description : 'The public port', type : 'string'}, {name : 'created', description : 'The date when this Instance group was created', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'publicipid', description : 'The public IP address ID', type : 'string'}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {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 : 'state', description : 'The current state of the AutoScale Instance Group', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}], httprequesttype : 'GET'}, {name : 'registerUserData', description : 'Register a new User Data.', since : '4.18', isasync : False, params : [{name : 'name', description : 'Name of the user data', type : 'string', length : 255, required : True}, {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 : '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 : '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}], 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 : 'listAccounts', description : 'Lists Accounts and provides detailed Account information for listed Accounts', isasync : False, related : 'disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts', params : [{name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'name', description : 'List account by account name', 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 : '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 : '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 : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'iscleanuprequired', description : 'List accounts by cleanuprequired attribute (values are true or false)', type : 'boolean', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'showicon', description : 'Flag to display the resource icon for accounts', type : 'boolean', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'tag', description : 'Tag for resource type to return usage', type : 'string', length : 255, required : False, since : '4.20.0'}, {name : 'state', description : 'List accounts by state. Valid states are enabled, disabled, and locked.', type : 'string', 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 : '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}], response : [{name : 'defaultzoneid', description : 'The default zone of the Account', type : 'string'}, {name : 'domain', description : 'Name of the Domain the Account belongs to', type : 'string'}, {name : 'cputotal', description : 'The total number of CPU cores owned by account', type : 'long'}, {name : 'bucketlimit', description : 'the total number of buckets which can be stored by this account', type : 'string'}, {name : 'vmavailable', description : 'The total number of Instances available for this Account to acquire', type : 'string'}, {name : 'networktotal', description : 'The total number of Networks owned by Account', type : 'long'}, {name : 'isdefault', description : 'True if account is default, false otherwise', type : 'boolean'}, {name : 'groups', description : 'The list of ACL groups that account belongs to', type : 'list'}, {name : 'templatetotal', description : 'The total number of Templates which have been created by this Account', type : 'long'}, {name : 'vmtotal', description : 'The total number of Instances deployed by this Account', type : 'long'}, {name : 'networklimit', description : 'The total number of Networks the Account can own', type : 'string'}, {name : 'backupstorageavailable', description : 'the total backup storage space (in GiB) available to the account', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'primarystorageavailable', description : 'The total primary storage space (in GiB) available to be used for this account', type : 'string'}, {name : 'memoryavailable', description : 'The total memory (in MB) available to be created for this account', type : 'string'}, {name : 'projectlimit', description : 'The total number of projects the Account can own', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'domainpath', description : 'Path of the Domain the Account belongs to', type : 'string'}, {name : 'backupavailable', description : 'the total number of backups available to this account', type : 'string'}, {name : 'templateavailable', description : 'The total number of Templates available to be created by this Account', type : 'string'}, {name : 'vmstopped', description : 'The total number of Instances stopped for this Account', type : 'integer'}, {name : 'networkavailable', description : 'The total number of Networks available to be created for this Account', type : 'string'}, {name : 'secondarystoragelimit', description : 'The total secondary storage space (in GiB) the account can own', type : 'string'}, {name : 'accounttype', description : 'Account type (admin, domain-admin, user)', type : 'integer'}, {name : 'templatelimit', description : 'The total number of Templates which can be created by this Account', type : 'string'}, {name : 'vpcavailable', description : 'The total number of VPCs available to be created for this account', type : 'string'}, {name : 'cpuavailable', description : 'The total number of CPU cores available to be created for this account', type : 'string'}, {name : 'volumeavailable', description : 'The total volume available for this Account', type : 'string'}, {name : 'backupstoragelimit', description : 'the total backup storage space (in GiB) the account can own', type : 'string'}, {name : 'state', description : 'The state of the account', type : 'string'}, {name : 'projectavailable', description : 'The total number of projects available for administration by this Account', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'vpclimit', description : 'The total number of VPCs the Account can own', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'taggedresources', description : 'The tagged resource limit and count for the account', type : 'list'}, {name : 'created', description : 'The date when this account was created', type : 'date'}, {name : 'networkdomain', description : 'The Network domain', type : 'string'}, {name : 'vpctotal', description : 'The total number of VPCs owned by account', type : 'long'}, {name : 'objectstorageavailable', description : 'the total object storage space (in GiB) available to the account', type : 'string'}, {name : 'user', description : 'The list of users associated with account', type : 'list', response : [{name : 'apikey', description : 'The API key of the user', type : 'string'}, {name : 'email', description : 'The user email address', type : 'string'}, {name : 'is2faenabled', description : 'True if user has two factor authentication enabled', type : 'boolean'}, {name : 'usersource', description : 'The source type of the user in lowercase, such as native, ldap, saml2', type : 'string'}, {name : 'accounttype', description : 'The Account type of the user', type : 'integer'}, {name : 'lastname', description : 'The user lastname', type : 'string'}, {name : 'timezone', description : 'The timezone user was created in', type : 'string'}, {name : 'iscallerchilddomain', description : "The boolean value representing if the updating target is in caller's child domain", type : 'boolean'}, {name : 'secretkey', description : 'The secret key of the user', type : 'string'}, {name : 'accountid', description : 'The Account ID of the user', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'domainid', description : 'The domain ID of the user', type : 'string'}, {name : 'state', description : 'The user state', type : 'string'}, {name : 'id', description : 'The user ID', type : 'string'}, {name : 'created', description : 'The date and time the user 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 : 'roletype', description : 'The type of the role', type : 'string'}, {name : 'rolename', description : 'The name of the role', type : 'string'}, {name : 'account', description : 'The Account name of the user', type : 'string'}, {name : 'username', description : 'The user name', type : 'string'}, {name : 'is2famandated', description : 'True if user has two factor authentication is mandated', type : 'boolean'}, {name : 'firstname', description : 'The user firstname', type : 'string'}, {name : 'domain', description : 'The domain name of the user', type : 'string'}, {name : 'isdefault', description : 'True if user is default, false otherwise', type : 'boolean'}, {name : 'roleid', description : 'The ID of the role', type : 'string'}]}, {name : 'gputotal', description : 'the total number of gpus owned by account', type : 'long'}, {name : 'memorytotal', description : 'The total memory (in MB) owned by account', type : 'long'}, {name : 'primarystoragelimit', description : 'The total primary storage space (in GiB) the account can own', type : 'string'}, {name : 'ipavailable', description : 'The total number of public IP addresses available for this Account to acquire', type : 'string'}, {name : 'snapshotavailable', description : 'The total number of Snapshots available for this Account', type : 'string'}, {}, {name : 'projecttotal', description : 'The total number of projects being administrated by this Account', type : 'long'}, {name : 'name', description : 'The name of the Account', type : 'string'}, {name : 'roleid', description : 'The ID of the role', type : 'string'}, {name : 'backuptotal', description : 'the total number of backups stored by this account', type : 'long'}, {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 : 'objectstoragelimit', description : 'the total object storage space (in GiB) the account can own', type : 'string'}, {name : 'memorylimit', description : 'The total memory (in MB) the account can own', type : 'string'}, {name : 'rolename', description : 'The name of the role', type : 'string'}, {name : 'snapshottotal', description : 'The total number of Snapshots stored by this Account', type : 'long'}, {name : 'backuplimit', description : 'the total number of backups which can be stored by this account', type : 'string'}, {name : 'volumetotal', description : 'The total volume being used by this Account', type : 'long'}, {name : 'gpulimit', description : 'the total number of gpus the account can own', type : 'string'}, {name : 'snapshotlimit', description : 'The total number of Snapshots which can be stored by this Account', type : 'string'}, {name : 'secondarystoragetotal', description : 'The total secondary storage space (in GiB) owned by account', type : 'float'}, {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 : 'buckettotal', description : 'the total number of buckets stored by this account', type : 'long'}, {name : 'objectstoragetotal', description : 'the total object storage space (in GiB) owned by the account', type : 'long'}, {name : 'iscleanuprequired', description : 'True if the account requires cleanup', type : 'boolean'}, {name : 'volumelimit', description : 'The total volume which can be used by this Account', type : 'string'}, {name : 'iptotal', description : 'The total number of public IP addresses allocated for this Account', type : 'long'}, {name : 'roletype', description : 'The type of the role (Admin, ResourceAdmin, DomainAdmin, User)', type : 'string'}, {name : 'vmlimit', description : 'The total number of Instances that can be deployed by this Account', type : 'string'}, {name : 'cpulimit', description : 'The total number of CPU cores the account can own', type : 'string'}, {name : 'bucketavailable', description : 'the total number of buckets available to this account', type : 'string'}, {name : 'gpuavailable', description : 'the total number of gpus available to be created for this account', type : 'string'}, {name : 'secondarystorageavailable', description : 'The total secondary storage space (in GiB) available to be used for this account', type : 'string'}, {name : 'domainid', description : 'ID of the Domain the Account belongs to', type : 'string'}, {name : 'primarystoragetotal', description : 'The total primary storage space (in GiB) owned by account', type : 'long'}, {name : 'backupstoragetotal', description : 'the total backup storage space (in GiB) owned by the account', type : 'long'}, {name : 'apikeyaccess', description : 'whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)', type : 'apikeyaccess'}, {}], 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 : '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 : '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 : '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'}, {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 : '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 : 'domainid', description : 'Domain ID of the Account owning an autoscale Instance profile', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'account', description : 'Account that will own the autoscale Instance profile', type : 'string', length : 255, required : False}, {name : 'userdataid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.18.1', related : 'listCniConfiguration'}, {name : 'zoneid', description : 'Availability zone for the auto deployed Instance', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is expunged', type : 'integer', length : 255, required : False}, {name : 'serviceofferingid', description : 'The service offering of the auto deployed Instance', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {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 : '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 : '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}], response : [{}, {name : 'userdata', description : 'Base64 encoded Instance user data', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance profile', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance profile', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'domainpath', description : 'path of the domain to which the vm profile belongs', type : 'string'}, {name : 'autoscaleuserid', description : 'The ID of the User used to launch and destroy the Instances', type : 'string'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer'}, {name : 'zoneid', description : 'The availability zone 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 : 'templateid', description : 'The Template to be used while deploying an Instance', 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'userdataid', description : 'the id of userdata used for the VM', type : 'string'}, {name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance', type : 'map'}, {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 : 'serviceofferingid', description : 'The service offering to be used while deploying an Instance', type : 'string'}, {name : 'userdatadetails', description : 'list of variables and values for the variables declared in userdata', type : 'string'}, {}, {}, {name : 'projectid', description : 'The project id Instance profile', type : 'string'}], httprequesttype : 'POST'}, {name : 'syncVmwareCbtMigration', description : 'Run a VMware CBT delta synchronization cycle', since : '4.24.0', isasync : True, related : 'listVmwareCbtMigrations,cutoverVmwareCbtMigration,cancelVmwareCbtMigration', params : [{name : 'password', description : 'optional password override for the source vCenter. Stored external vCenter credentials are used when available', type : 'string', length : 255, required : False}, {name : 'username', description : 'optional username override for the source vCenter. Stored external vCenter credentials are used when available', type : 'string', length : 255, required : False}, {name : 'id', description : 'the VMware CBT migration ID', type : 'uuid', length : 255, required : True, related : 'listVmwareCbtMigrations,syncVmwareCbtMigration,cutoverVmwareCbtMigration,cancelVmwareCbtMigration'}], response : [{name : 'virtualmachineid', description : 'the ID of the imported VM after cutover', type : 'string'}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'string'}, {name : 'currentstepduration', description : 'the elapsed time spent in the current migration step', type : 'string'}, {name : 'vcenter', description : 'the source VMware vCenter', type : 'string'}, {name : 'existingvcenterid', description : 'the linked existing vCenter ID, when used', type : 'string'}, {name : 'convertinstancehostname', description : 'the KVM host name selected for conversion and CBT replication', 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', type : 'string'}, {name : 'poolname', description : 'the storage pool name selected for converted disks', type : 'string'}, {name : 'created', description : 'the create date of the VMware CBT migration', type : 'date'}, {name : 'completedcycles', description : 'the number of completed CBT delta cycles', type : 'int'}, {name : 'datacentername', description : 'the source VMware datacenter', type : 'string'}, {name : 'lastdirtyrate', description : 'the dirty rate in bytes per second observed in the last CBT delta cycle', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'cycle', description : 'the CBT delta synchronization cycles tracked by this VMware CBT migration', type : 'list'}, {}, {name : 'lastchangedbytes', description : 'the changed bytes observed in the last CBT delta cycle', type : 'long'}, {name : 'id', description : 'the ID of the VMware CBT migration', type : 'string'}, {name : 'displayname', description : 'the display name of the target VM', type : 'string'}, {name : 'sourcecluster', description : 'the source VMware cluster', type : 'string'}, {name : 'zoneid', description : 'the destination zone ID', type : 'string'}, {name : 'lasterror', description : 'the last migration error', type : 'string'}, {name : 'zonename', description : 'the destination zone name', type : 'string'}, {name : 'currentstep', description : 'the current migration step', type : 'string'}, {name : 'quietcycles', description : 'the number of consecutive quiet CBT delta cycles', type : 'int'}, {name : 'convertinstancehostid', description : 'the KVM host selected for conversion and CBT replication', type : 'string'}, {name : 'convertinstancepoolid', description : 'the storage pool selected for converted disks', type : 'string'}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'lastupdated', description : 'the last updated date of the VMware CBT migration', type : 'date'}, {name : 'clustername', description : 'the destination KVM cluster name', type : 'string'}, {name : 'state', description : 'the migration state', type : 'string'}, {name : 'totalchangedbytes', description : 'the total changed bytes synchronized across CBT delta cycles', type : 'long'}, {name : 'disk', description : 'the source and target disks tracked by this VMware CBT migration', type : 'list'}, {name : 'sourcehost', description : 'the source VMware ESXi host', type : 'string'}], 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 : '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'}, {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'}], 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 : 'updateBackupSchedule', description : 'Updates a User-defined Instance backup schedule', since : '4.14.0', isasync : False, related : '', params : [{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 : '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 : '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 : '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 : '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'}], response : [{name : 'account', description : 'Account name', type : 'string'}, {name : 'status', description : 'Backup status', type : 'status'}, {name : 'validationstatus', description : 'Backup validation status.', type : 'validationstatus'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'name of the backup', type : 'string'}, {}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'id', description : 'ID of the Instance backup', 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 : 'isbackupvmexpunged', description : 'Indicates whether the VM from which the backup was taken is expunged or not', type : 'boolean'}, {name : 'backupofferingname', description : 'Backup offering name', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'externalid', description : 'External backup id', type : 'string'}, {name : 'backupofferingid', description : 'Backup offering id', type : 'string'}, {name : 'description', description : 'description for the backup', type : 'string'}, {name : 'hostid', description : 'Host ID where the backup is running', type : 'string'}, {name : 'type', description : 'Backup type', type : 'string'}, {name : 'compressionstatus', description : 'Backup compression status.', type : 'compressionstatus'}, {name : 'vmbackupofferingremoved', description : 'The backup offering corresponding to this backup was removed from the VM', type : 'boolean'}, {name : 'tocheckpointid', description : 'Next checkpoint ID for incremental backups', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'volumes', description : 'Backed up volumes', type : 'string'}, {name : 'accountid', description : 'Account id', type : 'string'}, {name : 'domain', description : 'Domain name', type : 'string'}, {name : 'vmdetails', description : 'Lists the vm specific details for the backup', type : 'map'}, {name : 'fromcheckpointid', description : 'Previous active checkpoint ID for incremental backups', type : 'string'}, {name : 'virtualsize', description : 'Backup protected (virtual) size in bytes', type : 'long'}, {name : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {name : 'domainid', description : 'Domain ID', type : 'string'}, {name : 'created', description : 'Backup date', type : 'date'}, {name : 'zone', description : 'Zone name', type : 'string'}, {name : 'intervaltype', description : 'Interval type of the backup', type : 'string'}], httprequesttype : 'POST'}, {name : 'createPrivateGateway', description : 'Creates a private gateway', since : '4.17.0', isasync : True, related : 'createPrivateGateway,listPrivateGateways', params : [{name : 'bypassvlanoverlapcheck', description : 'When true bypasses VLAN id/range overlap check during private gateway creation', type : 'boolean', length : 255, required : False}, {name : 'ipaddress', description : 'The IP address of the Private Gateway', type : 'string', length : 255, required : True}, {name : 'aclid', description : 'The ID of the Network ACL', type : 'uuid', length : 255, required : False, related : 'createNetworkACLList,listNetworkACLLists'}, {name : 'physicalnetworkid', description : 'The Physical Network ID the network belongs to', type : 'uuid', length : 255, required : False, related : 'listPhysicalNetworks,updatePhysicalNetwork'}, {name : 'vpcid', description : 'The VPC Network belongs to', type : 'uuid', length : 255, required : True, related : 'listVPCs,createVPC,listVPCs,updateVPC'}, {name : 'netmask', description : 'The Netmask of the Private Gateway', type : 'string', length : 255, required : True}, {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'}, {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 : '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 : 'vlan', description : 'The network implementation uri for the private gateway', type : 'string', length : 255, required : False}], response : [{name : 'id', description : 'The ID of the private gateway', type : 'string'}, {name : 'zonename', description : 'The name of the zone the private gateway belongs to', type : 'string'}, {name : 'vlan', description : 'The Network implementation uri for the private gateway', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'aclid', description : 'ACL ID set for 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 : 'physicalnetworkid', description : 'The physical Network id', type : 'string'}, {name : 'associatednetworkid', description : 'The ID of the Network associated with this private gateway', type : 'string'}, {name : 'associatednetwork', description : 'The name of the Network associated with this private gateway', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the private gateway', type : 'string'}, {name : 'state', description : 'State of the gateway, can be Creating, Ready, Deleting', 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 : 'domain', description : 'The domain associated with the private gateway', type : 'string'}, {name : 'gateway', description : 'The gateway', type : 'string'}, {name : 'aclname', description : 'ACL name set for private gateway', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the private gateway belongs', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'project', description : 'The project name of the private gateway', type : 'string'}, {name : 'projectid', description : 'The project ID of the private gateway', type : 'string'}, {name : 'netmask', description : "The private gateway's netmask", type : 'string'}, {name : 'account', description : 'The Account associated with the private gateway', type : 'string'}, {name : 'vpcid', description : 'VPC ID the private gateway belongs to', 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 : '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 : '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 : 'properties', description : 'used to specify the vApp properties.', type : 'map', length : 255, required : False, since : '4.15'}, {name : 'dynamicscalingenabled', description : 'true if virtual machine needs to be dynamically scalable', type : 'boolean', length : 255, required : False, since : '4.16'}, {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 : '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 : '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 : '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 : '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 : 'startvm', description : 'true if start vm after creating; defaulted to true if not specified', 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 : 'zoneid', description : 'availability zone for the virtual machine', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'name', description : 'host name for the virtual machine', type : 'string', length : 255, required : False}, {name : 'macaddress', description : "the mac address for default vm's network", type : 'string', length : 255, required : False}, {name : 'leaseduration', description : 'Number of days instance is leased for.', type : 'integer', length : 255, required : False, since : '4.21.0'}, {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 : '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 : 'userdataid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.18', related : 'listCniConfiguration'}, {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 : '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 : '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 : 'resetpassword', description : 'For a password enabled template, whether to generate a new password for the created Instance and return it in the response. If not specified, the zone setting `restore.vm.from.backup.reset.password` decides.', type : 'boolean', length : 255, required : False, since : '4.22.1.0'}, {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 : 'leaseexpiryaction', description : 'Lease expiry action, valid values are STOP and DESTROY', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'keypair', description : 'name of the ssh key pair used to login to the virtual machine', type : 'string', length : 255, required : False}, {name : 'size', description : 'the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId', type : 'long', length : 255, required : False}, {name : 'backupid', description : 'backup ID to create the VM from', type : 'uuid', length : 255, required : True, related : ''}, {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 : 'serviceofferingid', description : 'the ID of the service offering for the virtual machine', type : 'uuid', length : 255, required : False, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {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 : 'group', description : 'an optional group for the virtual machine', type : 'string', length : 255, required : False}, {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 : 'deploymentplanner', description : 'Deployment planner to use for vm allocation. Available to ROOT admin only', type : 'string', length : 255, required : False, since : '4.4'}, {name : 'ip6address', description : "the ipv6 address for default vm's network", 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 : '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 : '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 : 'nicpackedvirtqueuesenabled', description : 'Enable packed virtqueues or not.', type : 'boolean', length : 255, required : False, since : '4.18'}, {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 : 'projectid', description : 'Deploy vm for the project', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'userdatadetails', description : 'used to specify the parameters values for the variables in userdata.', type : 'map', length : 255, required : False, since : '4.18'}, {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 : 'iodriverpolicy', description : 'Controls specific policies on IO', type : 'string', 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 : '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 : '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 : '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 : '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 : '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 : '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 : '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 : '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 : 'displayname', description : 'an optional user generated name for the virtual machine', type : 'string', 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 : '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 : '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 : 'account', description : 'an optional account for the virtual machine. Must be used with domainId.', type : 'string', length : 255, required : False}, {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 : '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 : 'ipaddress', description : "the ip address for default vm's network", type : 'string', length : 255, required : False}], response : [{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 : '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 : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {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 : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', 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 : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {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 : '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 : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', 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 : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {}, {name : 'zonename', description : 'The name of the availability zone for 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 : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of 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 : 'domain', description : 'The domain 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 : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}]}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {}, {}, {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 : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying 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 : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', 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 : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'servicestate', description : 'State of the Service from LB rule', 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 : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used 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 : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to 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 : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', 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 : 'sentbytes', description : 'The total number of Network traffic bytes sent', 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 : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{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 : '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 : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {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 : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'traffictype', description : 'The traffic type 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 : '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 : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', 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 : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', 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 : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {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 : 'domain', description : '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 : '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 : 'resourceid', description : 'ID of the resource', 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 : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'securitygroupname', description : 'Security group name', 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 : '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 : 'protocol', description : 'The protocol of the security group rule', 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 : '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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', 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 : '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 : 'key', description : 'Tag key name', 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 : '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 : '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 : '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 : 'account', description : 'Account owning the security group rule', 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 : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', 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 : '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 : 'domain', description : 'The domain associated with the tag', type : 'string'}]}]}, {name : 'name', description : 'The name of the security group', 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 : 'project', description : 'The project name of the group', type : 'string'}, {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 : 'description', description : 'The description 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 : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {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 Instance', type : 'string'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}], httprequesttype : 'POST'}, {name : 'updateVMSchedule', description : 'Update Instance Schedule.', since : '4.19.0', isasync : False, related : '', params : [{name : 'id', description : 'ID of Instance schedule', type : 'uuid', length : 255, required : True, related : 'updateVMSchedule'}, {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 : '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 : 'enabled', description : 'Enable Instance schedule', type : 'boolean', length : 255, required : False}, {name : 'startdate', description : 'Start date from which the schedule becomes active(Format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}], response : [{name : 'description', description : 'Description of Instance schedule', type : 'string'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'action', description : 'Action', type : 'action'}, {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 : 'virtualmachineid', description : 'ID of Instance', type : 'string'}, {}, {name : 'enabled', description : 'VM schedule is enabled', type : 'boolean'}, {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 : 'id', description : 'The ID of Instance schedule', type : 'string'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}], httprequesttype : 'POST'}, {name : 'createInstanceBootGroupReadinessRule', description : 'Creates a readiness rule for an Instance or Instance Group that is a member (directly, or via its instance group) of an Instance Boot Group', since : '24.0', isasync : False, related : 'updateInstanceBootGroupReadinessRule', params : [{name : 'details', description : 'Rule-type-specific configuration, e.g. port/protocol, script, threshold_type/threshold_value', type : 'map', length : 255, required : False}, {name : 'ruletype', description : 'The readiness rule type: GuestAgentLiveness, Ping, PortCheck or MemberQuorum', type : 'string', length : 255, required : True}, {name : 'instancegroupid', description : 'The ID of the Instance Group this rule applies to (exclusive with virtualmachineid)', type : 'uuid', length : 255, required : False, related : 'updateInstanceGroup'}, {name : 'enabled', description : 'Whether the rule is enabled; defaults to true', type : 'boolean', length : 255, required : False}, {name : 'bootgroupid', description : 'The ID of the Instance Boot Group this rule belongs to', type : 'uuid', length : 255, required : True, related : 'startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup'}, {name : 'name', description : 'The name of the readiness rule; auto-generated if not provided', type : 'string', length : 255, required : False}, {name : 'virtualmachineid', description : 'The ID of the Instance this rule applies to (exclusive with instancegroupid)', 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'}], response : [{name : 'memberid', description : 'The ID of the item (VM or instance group) this rule applies to', type : 'string'}, {name : 'id', description : 'The ID of the readiness rule', type : 'string'}, {name : 'inherited', description : "True if this rule is not attached to the queried item directly, but inherited from its owning InstanceGroup (only possible when listing by virtualmachineid; the rule's itemtype/itemid still refer to the InstanceGroup it's actually attached to)", type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'membername', description : 'The name of the item (VM or instance group) this rule applies to', type : 'string'}, {name : 'bootgroupid', description : 'The ID of the boot group this rule belongs to', type : 'string'}, {name : 'created', description : 'The date the rule was created', type : 'date'}, {name : 'enabled', description : 'Whether the rule is enabled', type : 'boolean'}, {name : 'checkedon', description : 'When this rule was last evaluated', type : 'date'}, {}, {name : 'ruletype', description : 'The readiness rule type', type : 'string'}, {name : 'membertype', description : 'The item type this rule applies to: VirtualMachine or InstanceGroup', type : 'string'}, {name : 'statusmessage', description : 'The message from the last evaluation of this rule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'readinessstatus', description : 'The last cached evaluation status of this rule: READY, NOT_READY, ERROR or UNKNOWN', type : 'string'}, {name : 'details', description : 'Rule-type-specific configuration', type : 'map'}, {}, {name : 'name', description : 'The name of the readiness rule', type : 'string'}], httprequesttype : 'POST'}, {name : 'listGpuDevices', description : 'Lists all available GPU devices', since : '4.21.0', isasync : False, related : 'listGpuDevices,discoverGpuDevices,createGpuDevice', params : [{name : 'gpucardid', description : 'the GPU card ID associated with the GPU device', type : 'uuid', length : 255, required : False, related : 'listGpuCards'}, {name : 'vgpuprofileid', description : 'the vGPU profile ID assigned to the GPU device', type : 'uuid', length : 255, required : False, related : 'createVgpuProfile,updateVgpuProfile'}, {name : 'id', description : 'ID of the GPU device', type : 'uuid', length : 255, required : False, related : 'listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'hostid', description : 'the host ID where the GPU device is attached', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,listHosts,reconnectHost'}, {name : 'pagesize', 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 : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'hostname', description : 'the host name where the GPU device is attached', type : 'string'}, {}, {name : 'busaddress', description : 'bus address of the GPU device or MDEV UUID for vGPU devices', type : 'string'}, {name : 'gpucardid', description : 'the GPU card ID associated with this GPU device', type : 'string'}, {name : 'state', description : 'the vGPU profile name assigned to this GPU device', type : 'state'}, {name : 'virtualmachinename', description : 'the vGPU profile name assigned to this GPU device', type : 'string'}, {name : 'managedstate', description : 'the managed state of the GPU device (Enabled/Disabled)', type : 'managedstate'}, {name : 'vgpuprofilename', description : 'the vGPU profile name assigned to this GPU device', type : 'string'}, {name : 'vmstate', description : 'the state of the virtual machine to which this GPU device is allocated', type : 'state'}, {name : 'parentgpudeviceid', description : 'the ID of the parent GPU device, if this is a vGPU', type : 'string'}, {name : 'gpudevicetype', description : 'bus address of the GPU device', type : 'devicetype'}, {name : 'hostid', description : 'the host ID where the GPU device is attached', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'gpucardname', description : 'the GPU card name associated with this GPU device', type : 'string'}, {name : 'id', description : 'the ID of the GPU device', type : 'string'}, {}, {name : 'vgpuprofileid', description : 'the vGPU profile ID assigned to this GPU device', type : 'string'}, {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'}], httprequesttype : 'GET'}, {name : 'assignVirtualMachineToBackupOffering', description : 'Assigns an Instance to a backup offering', since : '4.14.0', isasync : True, params : [{name : 'backupofferingid', description : 'ID of the backup offering', type : 'uuid', length : 255, required : True, related : 'listBackupOfferings,updateBackupOffering,createBackupOffering'}, {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'}], 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 : 'listResourceIcon', description : 'Lists the resource icon for the specified resource(s)', since : '4.16.0.0', isasync : False, related : '', 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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'base64image', description : 'Base64 representation of resource icon', 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 : 'resourcetype', description : 'Resource type', type : 'resourceobjecttype'}], httprequesttype : 'GET'}, {name : 'listVirtualMachinesMetrics', description : 'Lists VM metrics', isasync : False, related : 'listVirtualMachinesMetrics', params : [{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 : '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 : 'hypervisor', description : 'The target hypervisor for the Template', 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 : 'hostid', description : 'The host ID', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,listHosts,reconnectHost'}, {name : 'serviceofferingid', description : 'List by the service offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'leased', description : 'Whether to return only leased instances', 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 : 'updateSecurityGroup'}, {name : 'groupid', description : 'The group ID', type : 'uuid', length : 255, required : False, related : 'updateInstanceGroup'}, {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 : '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 : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'clusterid', description : 'The cluster ID', type : 'uuid', length : 255, required : False, related : 'addCluster,updateCluster'}, {name : 'backupofferingid', description : 'List by the backup offering', type : 'uuid', length : 255, required : False, since : '4.17', related : 'listBackupOfferings,updateBackupOffering,createBackupOffering'}, {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 : 'podid', description : 'The pod ID', type : 'uuid', length : 255, required : False, related : 'listPods,createManagementNetworkIpRange'}, {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 : 'isoid', description : 'List Instances by ISO', type : 'uuid', length : 255, required : False}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", 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 : 'showicon', description : 'Flag to display the resource icon for Instances', type : 'boolean', length : 255, required : False, since : '4.16.0.0'}, {name : 'pagesize', description : '', type : 'integer', 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 : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', 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 : 'arch', description : 'CPU arch of the VM', type : 'string', length : 255, required : False, since : '4.20.1'}, {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 : 'zoneid', description : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'userdataid', description : 'the instances by userdata', type : 'uuid', length : 255, required : False, since : '4.20.1', related : 'listCniConfiguration'}, {name : 'keyword', description : 'List by keyword', 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 : '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 : '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 : '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 : '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 : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', 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 : 'vpcid', description : 'List Instances by VPC', type : 'uuid', length : 255, required : False, related : 'listVPCs,createVPC,listVPCs,updateVPC'}, {name : 'affinitygroupid', description : 'List Instances by affinity group', type : 'uuid', length : 255, required : False, related : 'createAffinityGroup,listAffinityGroups'}, {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 : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}], response : [{name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'diskiopstotal', description : 'The total disk iops', type : 'long'}, {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 : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', 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 : '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 : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'videoram', description : 'the video RAM size in MB', 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 : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'cputotal', description : 'The total cpu capacity in Ghz', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'memorytotal', description : 'The total memory capacity in GiB', type : 'string'}, {}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', 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 : '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 : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'account', description : 'Account owning the security group rule', 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 : '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 : '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 : '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 : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {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 : 'protocol', description : 'The protocol 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 : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', 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 : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{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 : '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 : 'project', description : 'The project name where tag belongs to', 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 : 'domain', description : 'The domain associated with the tag', 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 : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'projectid', description : 'The project id of the 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 : 'securitygroupname', description : 'Security group name', 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 : '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 : '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 : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{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 : 'domain', description : '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 : '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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}]}]}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {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 : 'domainpath', description : 'Path of the domain in which the virtual machine exists', 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 : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', 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 : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', 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 : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {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 : 'type', description : 'The type 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 : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'id', description : 'The 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 : 'domain', description : 'The domain name of the affinity group', 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 : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'networkwrite', description : 'Network write in MiB', type : 'string'}, {name : 'networkread', description : 'Network read in MiB', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', 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 : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'diskread', description : 'Disk read in MiB', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', 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 : '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 : '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 : 'name', description : 'The name of the attached ISO', type : 'string'}]}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', 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 : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'diskwrite', description : 'Disk write in MiB', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'hostname', description : 'The name of the host for 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 : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', 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 : '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 : '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 : '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 : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', 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 : '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 : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', 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 : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {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 : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', 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 Instance', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', 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 : '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 : '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 : 'id', description : 'The ID of the public IP address to reserve', type : 'uuid', length : 255, required : True, related : 'associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses'}, {name : 'fordisplay', description : 'An optional field, whether to the display the IP to the end User or not', type : 'boolean', length : 255, required : False}, {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 : 'account', description : 'The Account to reserve with this IP address', type : 'string', length : 255, required : False}], response : [{name : 'associatednetworkname', description : 'The name of the Network associated with the IP address', type : 'string'}, {name : 'vlanname', description : 'The VLAN associated with the IP address', type : 'string'}, {name : 'vmipaddress', description : 'Instance (DNAT) IP address (not null only for static NAT IP)', type : 'string'}, {name : 'virtualmachinedisplayname', description : 'Instance display name the IP address is assigned to (not null only for static NAT IP)', type : 'string'}, {name : 'forprovider', description : 'true if range is dedicated for external network providers', type : 'boolean'}, {name : 'zonename', description : 'The name of the zone the public IP address belongs to', type : 'string'}, {name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {name : 'isstaticnat', description : 'True if this IP is for static NAT, false otherwise', type : 'boolean'}, {name : 'virtualmachinetype', description : 'Instance type the IP address is assigned to', type : 'string'}, {name : 'virtualmachinename', description : 'Instance name the IP address is assigned to', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'vpcid', description : 'VPC ID the IP belongs to', type : 'string'}, {name : 'issourcenat', description : 'True if the IP address is a source NAT address, false otherwise', type : 'boolean'}, {name : 'account', description : 'The Account the public IP address is associated with', type : 'string'}, {name : 'virtualmachineid', description : 'Instance id the IP address is assigned to', type : 'string'}, {name : 'hasrules', description : 'Whether the IP address has Firewall/PortForwarding/LoadBalancing rules defined', type : 'boolean'}, {name : 'state', description : 'State of the IP address. Can be: Allocating, Allocated, Releasing, Reserved and Free', type : 'string'}, {name : 'isportable', description : 'Is public IP portable across the zones', type : 'boolean'}, {name : 'domain', description : 'The domain the public IP address is associated with', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the IP address', type : 'boolean'}, {name : 'allocated', description : 'Date the public IP address was acquired', type : 'date'}, {name : 'domainid', description : 'The domain ID the public IP address is associated with', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with IP address', type : 'list', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', 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 : '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 : 'domainpath', description : 'Path of the Domain 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 : 'domainpath', description : 'path of the domain to which the public IP address belongs', type : 'string'}, {name : 'fordisplay', description : 'Is public IP for display to the regular user', type : 'boolean'}, {name : 'project', description : 'The project name of the address', type : 'string'}, {name : 'ipaddress', description : 'Public IP address', 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 : 'vpcname', description : 'VPC name the IP belongs to', type : 'string'}, {name : 'associatednetworkid', description : 'The ID of the Network associated with the IP address', type : 'string'}, {name : 'issystem', description : 'True if this IP is system IP (was allocated as a part of deployVm or createLbRule)', type : 'boolean'}, {name : 'zoneid', description : 'The ID of the zone the public IP address belongs to', type : 'string'}, {name : 'networkid', description : 'The ID of the Network where IP belongs to', 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 : 'id', description : 'Public IP address ID', type : 'string'}, {name : 'physicalnetworkid', description : 'The physical Network this belongs to', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'networkname', description : 'The name of the Network where IP belongs to', type : 'string'}, {name : 'forsystemvms', description : 'true if range is dedicated for System VMs', type : 'boolean'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'deleteVMSchedule', description : 'Delete Instance Schedule.', since : '4.19.0', isasync : False, params : [{name : 'ids', description : 'IDs of Instance schedule', type : 'list', length : 255, required : False, related : ''}, {name : 'id', description : 'ID of Instance schedule', type : 'uuid', length : 255, required : False, related : ''}, {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'}], 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 : 'deleteDnsRecord', description : 'Deletes a DNS record from the external provider', since : '4.23.0', isasync : True, params : [{name : 'name', description : '', type : 'string', length : 255, required : True}, {name : 'dnszoneid', description : 'The ID of the DNS zone', type : 'uuid', length : 255, required : True, related : 'listDnsZones'}, {name : 'type', description : '', type : 'string', 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 : '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 : '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 : '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 : 'projectroleid', description : 'The ID of the project role to which the role permission belongs', type : 'string'}, {name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'description', description : 'The description of the role permission', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'permission', description : 'The permission type of the api name or wildcard rule, allow/deny', type : 'string'}, {name : 'rule', description : 'The api name or wildcard rule', 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 project role permission', type : 'string'}, {name : 'projectrolename', description : 'The name of the project role to which the role permission belongs', 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 : 'encryption', description : 'Enable bucket encryption', type : 'boolean', length : 255, required : False}, {name : 'account', description : 'the account associated with the bucket. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'name', description : 'the name of the bucket', type : 'string', length : 255, required : True}, {name : 'projectid', description : 'the project associated with the bucket. Mutually exclusive with account parameter', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'quota', description : 'Bucket Quota in GiB', type : 'integer', length : 255, required : True}, {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 : 'versioning', description : 'Enable bucket versioning', type : 'boolean', length : 255, required : False}, {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 : 'objectlocking', description : 'Enable object locking in bucket', type : 'boolean', length : 255, required : False}], response : [{}, {}, {name : 'domainid', description : 'the ID of the domain associated with the bucket', type : 'string'}, {name : 'account', description : 'the account associated with the Bucket', type : 'string'}, {name : 'project', description : 'the project name of the bucket', type : 'string'}, {name : 'created', description : 'the date the Bucket was created', type : 'date'}, {name : 'quota', description : 'Bucket Quota in GiB', type : 'integer'}, {name : 'provider', description : 'Object storage provider', type : 'string'}, {name : 'domain', description : 'the domain associated with the bucket', type : 'string'}, {name : 'versioning', description : 'Bucket Versioning', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'value', description : 'Tag value', 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 : 'resourcetype', description : 'Resource type', 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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer 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 : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'domainpath', description : 'path of the domain to which the bucket belongs', type : 'string'}, {name : 'objectstorageid', description : 'id of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'size', description : 'Total size of objects in Bucket', type : 'long'}, {name : 'policy', description : 'Bucket Access Policy', type : 'string'}, {name : 'objectstore', description : 'Name of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'objectlocking', description : 'Bucket Object Locking', type : 'boolean'}, {name : 'projectid', description : 'the project id of the bucket', type : 'string'}, {name : 'encryption', description : 'Bucket Encryption', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : '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 : 'state', description : 'State of the Bucket', type : 'string'}, {name : 'accesskey', description : 'Bucket Access Key', type : 'string'}, {name : 'id', description : 'ID of the Bucket', type : 'string'}, {name : 'url', description : 'Bucket URL', type : 'string'}], httprequesttype : 'POST'}, {name : 'listRoutingFirewallRules', description : 'Lists all Routing firewall rules', since : '4.20.0', isasync : False, related : 'createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule', 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 : 'networkid', description : 'list Routing firewall rules by network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}, {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 : 'createProject'}, {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 : 'fordisplay', description : 'list resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', 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 : 'traffictype', description : 'list Routing firewall rules by traffic type - ingress or egress', type : 'string', length : 255, required : False}, {name : 'id', description : 'Lists Routing firewall rule with the specified ID', type : 'uuid', length : 255, required : False, related : 'listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule'}, {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 : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}], response : [{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 : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'privateport', description : "The starting 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 : '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 : '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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {}, {name : 'protocol', description : 'The protocol of the port forwarding 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 : 'domain', description : '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 : '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 : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the 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 : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {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 : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'id', description : 'The ID of the port forwarding rule', 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 : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {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'}], 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 : 'listBackupOfferings', description : 'Lists backup offerings', since : '4.14.0', isasync : False, related : 'updateBackupOffering,createBackupOffering', params : [{name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'The zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'id', description : 'The backup offering ID', type : 'uuid', length : 255, required : False, related : 'listBackupOfferings,updateBackupOffering,createBackupOffering'}, {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 : '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 : 'createDomain,listDomains,listDomains'}, {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}], response : [{name : 'provider', description : 'provider name', type : 'string'}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'domain', description : 'the domain name(s) this backup offering belongs to.', type : 'string'}, {name : 'id', description : 'ID of the backup offering', type : 'string'}, {}, {name : 'zonename', description : 'Zone name', type : 'string'}, {name : 'crosszoneinstancecreation', description : 'the backups with this offering can be used to create Instances on all Zones', type : 'boolean'}, {name : 'domainid', description : 'the domain ID(s) this backup offering belongs to.', type : 'string'}, {name : 'allowuserdrivenbackups', description : 'Whether the offering allows User driven ad-hoc/scheduled backups', 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 : 'description', description : 'Description for the backup offering', type : 'string'}, {name : 'backupofferingdetails', description : 'Details for the backup offering', type : 'map'}, {name : 'name', description : 'Name for the backup offering', type : 'string'}, {name : 'created', description : 'The date this backup offering was created', type : 'date'}, {name : 'externalid', description : 'External ID on the provider side', 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 : 'pagesize', 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 : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', 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 : 'forcks', description : 'list templates that can be used to deploy CKS clusters', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'oscategoryid', description : 'the ID of the OS category for the template', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listOsCategories'}, {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 : '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 : '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 : '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 : 'name', description : 'The Template name', type : 'string', length : 255, required : False}, {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 : 'showremoved', description : 'Show removed Templates as well', type : 'boolean', length : 255, required : False}, {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 : 'page', description : '', type : 'integer', length : 255, required : False}, {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 : '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 : 'zoneid', description : 'List Templates by zoneId', type : 'uuid', length : 255, required : False, related : 'listZones'}, {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 : 'showunique', description : 'If set to true, list only unique Templates across zones', type : 'boolean', length : 255, required : False, since : '4.13.2'}, {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 : 'isready', description : 'list templates that are ready to be deployed', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'hypervisor', description : 'The hypervisor for which to restrict the search', type : 'string', length : 255, required : False}, {name : 'showicon', description : 'Flag to display the resource image for the Templates', type : 'boolean', length : 255, required : False}], response : [{name : 'extensionname', description : 'The name of extension linked to this template', type : 'string'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}, {name : 'passwordenabled', description : 'True if the reset password feature is enabled, false otherwise', type : 'boolean'}, {name : 'name', description : 'The Template name', type : 'string'}, {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 : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'id', description : 'The Template ID', type : 'string'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {name : 'format', description : 'The format of the Template.', type : 'imageformat'}, {name : 'removed', description : 'The date this Template was removed', type : 'date'}, {name : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {name : 'ispublic', description : 'True if this Template is a public Template, false otherwise', type : 'boolean'}, {name : 'userdataid', description : 'The id of userdata linked to this 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 : 'sourcetemplateid', description : 'The Template ID of the parent Template if present', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {name : 'extensionid', description : 'The ID of extension linked to this 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 : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {name : 'directdownload', description : 'KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage', type : 'boolean'}, {name : 'crossZones', description : 'True if the Template is managed across all Zones, false otherwise', type : 'boolean'}, {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 : 'status', description : 'The status of the Template', type : 'string'}, {name : 'url', description : 'The URL which the Template/ISO is registered from', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', type : 'string'}, {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 : 'project', description : 'The project name where tag belongs to', 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 : '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 : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'accountid', description : 'The Account id to which the Template belongs', type : 'string'}, {name : 'project', description : 'The project name of the Template', type : 'string'}, {}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'templatetag', description : 'The tag of this Template', type : 'string'}, {}, {name : 'sshkeyenabled', description : 'True if Template is sshkey enabled, false otherwise', type : 'boolean'}, {name : 'isready', description : 'True if the Template is ready to be deployed from, false otherwise.', type : 'boolean'}, {name : 'requireshvm', description : 'True if Template requires HVM enabled, false otherwise', type : 'boolean'}, {name : 'userdataname', description : 'The name of userdata linked to this 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 : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean'}, {name : 'account', description : 'The Account name to which the Template belongs', type : 'string'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'displaytext', description : 'The Template display text', type : 'string'}, {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 : 'bits', description : 'The processor bit size', type : 'int'}, {}, {name : 'checksum', description : 'Checksum of the Template', type : 'string'}, {name : 'arch', description : 'CPU Arch of the template', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {name : 'hostname', description : 'The name of the secondary storage host for the Template', type : 'string'}, {name : 'domainid', description : 'The ID of the domain to which the Template belongs', type : 'string'}, {name : 'hostid', description : 'The ID 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 : 'isextractable', description : 'True if the Template is extractable, 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 : '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 : 'volumeid', description : '', type : 'uuid', length : 255, required : False, since : '4.21', related : 'importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}, {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 : 'leaseexpiryaction', description : 'Lease expiry action, valid values are STOP and DESTROY', type : 'string', length : 255, required : False, since : '4.21.0'}, {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 : 'iodriverpolicy', description : 'Controls specific policies on IO', type : 'string', length : 255, required : False}, {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 : '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 : '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 : 'startvm', description : 'true if start vm after creating; defaulted to true if not specified', type : 'boolean', length : 255, required : False}, {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 : 'dynamicscalingenabled', description : 'true if virtual machine needs to be dynamically scalable', type : 'boolean', length : 255, required : False, since : '4.16'}, {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 : 'size', description : 'the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId', type : 'long', 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 : 'leaseduration', description : 'Number of days instance is leased for.', type : 'integer', length : 255, required : False, since : '4.21.0'}, {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 : '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 : 'ip6address', description : "the ipv6 address for default vm's network", type : 'string', length : 255, required : False}, {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 : '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 : 'name', description : 'host name for the virtual machine', type : 'string', length : 255, required : False}, {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 : '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 : 'userdataid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.18', related : 'listCniConfiguration'}, {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 : '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 : 'macaddress', description : "the mac address for default vm's network", 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 : '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,reconnectHost'}, {name : 'properties', description : 'used to specify the vApp properties.', type : 'map', length : 255, required : False, since : '4.15'}, {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 : 'snapshotid', description : '', type : 'uuid', length : 255, required : False, since : '4.21', related : 'createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots'}, {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 : '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 : 'group', description : 'an optional group for the virtual machine', type : 'string', 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 : '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 : 'displayname', description : 'an optional user generated name for the virtual machine', type : 'string', length : 255, required : False}, {name : 'account', description : 'an optional account for the virtual machine. Must be used with domainId.', type : 'string', 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 : 'serviceofferingid', description : 'The ID of the Service offering for the Instance', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'nicmultiqueuenumber', description : 'The number of queues for multiqueue NICs.', type : 'integer', length : 255, required : False, since : '4.18'}, {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 : 'userdatadetails', description : 'used to specify the parameters values for the variables in userdata.', type : 'map', length : 255, required : False, since : '4.18'}, {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 : 'zoneid', description : 'availability zone for the virtual machine', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'keypair', description : 'name of the ssh key pair used to login to 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 : '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 : '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 : 'nicpackedvirtqueuesenabled', description : 'Enable packed virtqueues or not.', type : 'boolean', length : 255, required : False, since : '4.18'}, {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 : 'ipaddress', description : "the ip address for default vm's network", type : 'string', length : 255, required : False}, {name : 'projectid', description : 'Deploy vm for the project', type : 'uuid', length : 255, required : False, related : 'createProject'}, {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 : '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 : '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}], response : [{}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {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 : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{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 : 'endport', description : 'The ending IP of the security group rule ', 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 : '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 : '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 : 'account', description : 'The Account 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 : '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 : '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 : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {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 : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}]}, {name : 'domain', description : 'The domain name of the security 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 : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {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 : '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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'resourcetype', description : 'Resource type', 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 : '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 : 'value', description : 'Tag value', 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 : '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 : '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 : 'account', description : 'Account owning the security group rule', type : 'string'}]}, {name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', 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 : '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 : '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 : '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 : 'domainpath', description : 'Path of the Domain associated with the tag', 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 : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', 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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', 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 : 'resourceid', description : 'ID of the resource', 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 : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', 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 : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {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 : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', 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 : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by 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 : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {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 : '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 : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {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 : '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 : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'traffictype', description : 'The traffic type of the NIC', 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 : '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 : '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 : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {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 : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {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 : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'netmask', description : 'The netmask 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 : 'username', description : "The User's name who deployed the Instance", 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 : '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 : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {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 : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', 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 : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', 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 : '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 : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'id', description : 'The ID 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 : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}]}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone 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 : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'isoid', description : 'The ID 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 : '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 : 'id', description : 'The ID of the attached ISO', type : 'string'}]}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", 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 : '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 : '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 : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{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 : '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 : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', 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 : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', 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 : '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 : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {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 : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", 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 : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'traffictype', description : 'The traffic type of the NIC', 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 : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}]}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourceid', description : 'ID of the resource', 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 : 'resourcetype', description : 'Resource type', 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 : '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 : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}], 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 : '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'}, {name : 'networkid', description : 'The ID of the network', type : 'uuid', length : 255, required : True, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}], 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 : 'networkid', description : 'The ID of the 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 mapping', type : 'string'}, {name : 'dnszoneid', description : 'The ID of the DNS zone', type : 'string'}], httprequesttype : 'POST'}, {name : 'scaleKubernetesCluster', description : 'Scales a created, running or stopped CloudManaged Kubernetes cluster', isasync : True, related : 'createKubernetesCluster,startKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{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 : '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 : '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 : 'minsize', description : 'Minimum number of worker nodes in the cluster', type : 'long', length : 255, required : False}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {name : 'size', description : 'Number of Kubernetes cluster nodes', type : 'long', length : 255, required : False}, {name : 'maxsize', description : 'Maximum number of worker nodes in the cluster', type : 'long', length : 255, required : False}], response : [{name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {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 : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {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'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for 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 : '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 : 'templateid', description : 'The ID 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 : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {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 : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the 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 : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'etcdofferingid', description : 'the ID 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 : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on 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 : 'serviceofferingid', description : 'The ID 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 : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}], httprequesttype : 'POST'}, {name : 'destroyVolume', description : 'Destroys a Volume.', since : '4.14.0', isasync : True, related : 'importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume', 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 : 'importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}], response : [{name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {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 : 'path', description : 'The path of the volume', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', 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 : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {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 : 'status', description : 'The status of the volume', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the Instance', 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 : 'vmstate', description : 'State of the Instance', 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 : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {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 disk volume', type : 'string'}, {}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'diskofferingname', description : 'Name of the disk offering', 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 : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'kmskeyid', description : 'KMS key id 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 : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", 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 : 'customer', description : 'Customer 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 : '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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}]}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}], httprequesttype : 'POST'}, {name : 'stopSharedFileSystem', description : 'Stop a Shared FileSystem', since : '4.20.0', isasync : True, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering', params : [{name : 'forced', description : 'Force stop the shared filesystem.', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}], response : [{name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'serviceofferingname', description : 'service offering 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 : '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 : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', 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 : '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 : '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 : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {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 : 'ip6gateway', description : 'The gateway of IPv6 Network', 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 : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', 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 : 'networkname', description : 'The name of the corresponding Network', 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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}]}, {}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', 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 : '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 : '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 : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'projectid', description : 'the project ID of 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 : '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 : '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 : 'id', description : 'The ID of the System VM', type : 'uuid', length : 255, required : True, related : 'startSystemVm,changeServiceForSystemVm'}, {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 : 'serviceofferingid', description : 'The service offering ID to apply to the System VM', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}], response : [{name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', 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 : '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 : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {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 : 'linklocalip', description : 'The Control IP address for the System VM', 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 : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', 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 : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', 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 : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {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'}], 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 : '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 : 'listConsoleSessions', description : 'Lists console sessions.', since : '4.21.0', isasync : False, related : '', params : [{name : 'hostid', description : 'Lists console sessions from the specified host.', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,reconnectHost'}, {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 : '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 : '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 : 'domainid', description : 'The domain ID of the account that created the console endpoint.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'pagesize', description : '', type : 'integer', 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 : 'id', description : 'The ID of the console session.', type : 'uuid', length : 255, required : False, related : 'listConsoleSessions'}, {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 : 'userid', description : 'The ID of the user that created the console endpoint.', type : 'uuid', length : 255, required : False, related : 'disableUser,getUser,listUsers,lockUser'}, {name : 'consoleendpointcreatoraddress', description : 'IP address of the creator of the console endpoint.', type : 'string', length : 255, required : False}, {name : 'clientaddress', description : 'IP address of the client that accessed the console session.', type : 'string', 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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', 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}], response : [{name : 'domainpath', description : 'Domain path of the account that created the console endpoint.', type : 'string'}, {name : 'userid', description : 'ID of the user that created the console endpoint.', type : 'string'}, {name : 'consoleendpointcreatoraddress', description : 'IP address of the creator of the console endpoint.', type : 'string'}, {name : 'created', description : "Date when the console session's endpoint was created.", type : 'date'}, {name : 'domain', description : 'Domain of the account that created the console endpoint.', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the virtual machine.', type : 'string'}, {name : 'domainid', description : 'Domain ID of the account that created the console endpoint.', type : 'string'}, {name : 'account', description : 'Account that created the console endpoint.', type : 'string'}, {name : 'id', description : 'ID of the console session.', type : 'string'}, {name : 'acquired', description : 'Date when the console session was acquired.', type : 'date'}, {name : 'hostname', description : 'Name of the host.', type : 'string'}, {name : 'removed', description : 'Date when the console session was removed.', type : 'date'}, {}, {name : 'user', description : 'User that created the console endpoint.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'accountid', description : 'ID of the account that created the console endpoint.', type : 'string'}, {name : 'hostid', description : 'ID of the host.', type : 'string'}, {}, {name : 'virtualmachinename', description : 'Name of the virtual machine.', type : 'string'}, {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'}], httprequesttype : 'GET'}, {name : 'listCniConfiguration', description : 'List user data for CNI plugins', since : '4.21.0', isasync : False, related : '', 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 : '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 : '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 : '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 : '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,listDomains,listDomains'}], response : [{name : 'account', description : 'The owner of the User Data', type : 'string'}, {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 : 'domainpath', description : 'Path of the domain to which the User Data owner belongs', type : 'string'}, {name : 'projectid', description : 'The project id of the User Data', 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'}, {name : 'name', description : 'Name of the User Data', type : 'string'}, {name : 'id', description : 'ID of the User Data', type : 'string'}, {name : 'domain', description : 'The domain name of the User Data owner', type : 'string'}, {name : 'userdata', description : 'Base64 encoded User Data content', 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 : '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'}], 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 : 'name', description : 'The name of the Snapshot', type : 'string', length : 255, required : False}, {name : 'vmsnapshotid', description : 'The ID of the Instance Snapshot', type : 'uuid', length : 255, required : True, related : 'listVMSnapshot,createVMSnapshot'}, {name : 'volumeid', description : 'The ID of the disk volume', type : 'uuid', length : 255, required : True, related : 'importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'account', description : 'The Account associated with the Snapshot', 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 : 'zonename', description : 'name of the availability zone', type : 'string'}, {name : 'osdisplayname', description : 'Display name of the os on volume', type : 'string'}, {name : 'name', description : 'Name of the Snapshot', type : 'string'}, {name : 'datastorestate', description : 'state of the snapshot on the datastore', type : 'string'}, {name : 'virtualsize', description : 'Virtual size of backedup Snapshot on image store', type : 'long'}, {}, {name : 'intervaltype', description : 'Valid types are hourly, daily, weekly, monthy, Template, and none.', type : 'string'}, {name : 'ostypeid', description : 'ID of the os on volume', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'physicalsize', description : 'Physical size of backed up Snapshot on image store', type : 'long'}, {name : 'snapshottype', description : 'The type of the Snapshot', type : 'string'}, {name : 'volumeid', description : 'ID of the disk volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'ID of the Snapshot', type : 'string'}, {name : 'domainid', description : "The domain ID of the Snapshot's Account", type : 'string'}, {name : 'created', description : 'The date the Snapshot was created', type : 'date'}, {name : 'project', description : 'The project name of the Snapshot', type : 'string'}, {name : 'volumename', description : 'Name of the disk volume', type : 'string'}, {name : 'volumestate', description : 'state of the disk volume', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'domainpath', description : "path of the Domain the snapshot's account belongs to", type : 'string'}, {name : 'status', description : 'the status of the template', type : 'string'}, {name : 'parentname', description : 'The parent name of the Snapshot', 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 : 'datastoreid', description : 'ID of the datastore for the snapshot entry', type : 'string'}, {name : 'downloaddetails', description : 'download progress of a snapshot', type : 'map'}, {name : 'parent', description : 'The parent ID of the Snapshot', type : 'string'}, {name : 'domain', description : "The domain name of the Snapshot's Account", type : 'string'}, {name : 'datastoretype', description : 'type of the datastore for the snapshot entry', type : 'string'}, {name : 'locationtype', description : 'Valid location types are primary and secondary.', type : 'string'}, {name : 'projectid', description : 'The project id of the Snapshot', type : 'string'}, {}, {name : 'volumetype', description : 'Type of the disk volume', type : 'string'}, {name : 'revertable', description : 'Indicates whether the underlying storage supports reverting the volume to this Snapshot', type : 'boolean'}, {name : 'datastorename', description : 'name of the datastore for the snapshot entry', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{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 : '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 : '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 : 'resourceid', description : 'ID of the resource', type : 'string'}]}], httprequesttype : 'POST'}, {name : 'listDnsServers', description : 'Lists DNS servers owned by the account.', since : '4.23.0', isasync : False, related : 'addDnsServer', 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 : 'id', description : 'the ID of the DNS server', type : 'uuid', length : 255, required : False, related : 'addDnsServer,listDnsServers'}, {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 : '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 : '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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'url', description : 'URL of the DNS server API', type : 'string'}, {name : 'account', description : 'the account associated with the DNS server', 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 server', type : 'string'}, {name : 'provider', description : 'The provider type of the DNS server', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with 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 : '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 : 'ispublic', description : 'Is the DNS server publicly available', type : 'boolean'}, {name : 'name', description : 'Name of the DNS server', type : 'string'}, {name : 'port', description : 'The port of the DNS server', type : 'integer'}], httprequesttype : 'GET'}, {name : 'startInstanceBootGroup', description : 'Starts all Instances in an Instance Boot Group in order (lowest boot order first). Instances within the same order tier start concurrently', since : '24.0', isasync : True, related : 'stopInstanceBootGroup,rebootInstanceBootGroup', params : [{name : 'id', description : 'The ID of the Instance Boot Group', type : 'uuid', length : 255, required : True, related : 'startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup'}], response : [{name : 'readinessattempttimeoutseconds', description : 'Effective timeout in seconds for each readiness retry attempt (per-boot-group override if set, else the global default)', type : 'long'}, {}, {name : 'domainid', description : 'The domain ID of the instance boot group', type : 'string'}, {name : 'id', description : 'The ID of the instance boot group', 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 instance boot group', type : 'string'}, {}, {name : 'account', description : 'The account owning the instance boot group', type : 'string'}, {name : 'domainpath', description : 'The path of the domain the instance boot group belongs to', type : 'string'}, {name : 'domain', description : 'The domain name of the instance boot group', type : 'string'}, {name : 'readinessrebootonretry', description : 'Effective setting for whether an instance is rebooted between readiness retry attempts (per-boot-group override if set, else the global default)', type : 'boolean'}, {name : 'description', description : 'The description of the instance boot group', type : 'string'}, {name : 'readinessmaxretryattempts', description : 'Effective maximum number of readiness retry attempts (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'name', description : 'The name of the instance boot group', 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 boot group', type : 'string'}, {name : 'created', description : 'The date the instance boot group was created', type : 'date'}, {name : 'accountid', description : 'The account ID owning the instance boot group', type : 'string'}, {name : 'readinessinitialdelayseconds', description : 'Effective delay in seconds after starting or rebooting an instance before its first readiness check of that attempt (per-boot-group override if set, else the global default)', type : 'long'}], httprequesttype : 'POST'}, {name : 'listBuckets', description : 'Lists all Buckets.', since : '4.19.0', isasync : False, related : '', params : [{name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'id', description : 'the ID of the bucket', type : 'uuid', length : 255, required : False, related : 'listBuckets'}, {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 : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,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 : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'ids', description : 'the IDs of the Buckets, mutually exclusive with id', type : 'list', length : 255, required : False, related : 'listBuckets'}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', 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 : 'name', description : 'the name of the bucket', 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}], response : [{name : 'usersecretkey', description : 'Bucket Secret Key', type : 'string'}, {name : 'quota', description : 'Bucket Quota in GiB', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'value', description : 'Tag value', 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 : 'domainpath', description : 'Path 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 : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', 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 : 'created', description : 'the date the Bucket was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'objectstorageid', description : 'id of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'policy', description : 'Bucket Access Policy', type : 'string'}, {name : 'provider', description : 'Object storage provider', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the bucket belongs', type : 'string'}, {name : 'objectstore', description : 'Name of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the bucket', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'objectlocking', description : 'Bucket Object Locking', type : 'boolean'}, {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 : 'account', description : 'the account associated with 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 : 'id', description : 'ID of the Bucket', type : 'string'}, {}, {name : 'accesskey', description : 'Bucket Access Key', type : 'string'}, {name : 'encryption', description : 'Bucket Encryption', type : 'boolean'}, {name : 'versioning', description : 'Bucket Versioning', type : 'boolean'}, {}, {name : 'url', description : 'Bucket URL', type : 'string'}, {name : 'projectid', description : 'the project id of the bucket', type : 'string'}, {name : 'state', description : 'State of the Bucket', type : 'string'}], httprequesttype : 'GET'}, {name : 'stopInternalLoadBalancerVM', description : 'Stops an Internal LB Instance.', isasync : True, related : 'listRouters,changeServiceForRouter,listInternalLoadBalancerVMs', 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 internal LB Instance', type : 'uuid', length : 255, required : True, related : 'listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs'}], response : [{name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {name : 'linklocalnetworkid', description : 'The ID of the corresponding link local Network', type : 'string'}, {name : 'domain', description : 'The domain associated with the router', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'account', description : 'The Account associated with the router', type : 'string'}, {name : 'name', description : 'The name of the router', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with the router', type : 'set', response : [{name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', 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 : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', 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 : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', 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 : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {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 : '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 : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {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 : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', 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 : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}]}, {name : 'version', description : 'The version of Template', type : 'string'}, {name : 'created', description : 'The date and time the router was created', type : 'date'}, {name : 'hostid', description : 'The host ID for the router', type : 'string'}, {name : 'publicip', description : 'The public IP address for the router', type : 'string'}, {name : 'guestnetworkid', description : 'The ID of the corresponding guest Network', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the router', type : 'string'}, {name : 'templatename', description : 'The Template name for the router', type : 'string'}, {name : 'healthchecksfailed', description : 'True if any health checks had failed', type : 'boolean'}, {name : 'networkdomain', description : 'The Network domain for the router', type : 'string'}, {name : 'guestnetworkname', description : 'The name of the corresponding guest Network', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the router', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'vpcname', description : 'The name of VPC the router belongs to', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask 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 : 'publicnetworkid', description : 'The ID of the corresponding public Network', type : 'string'}, {name : 'isredundantrouter', description : 'If this router is an redundant virtual router', type : 'boolean'}, {name : 'gateway', description : 'The gateway for the router', type : 'string'}, {name : 'domainid', description : 'The domain ID associated with the router', type : 'string'}, {name : 'requiresupgrade', description : 'True if the router Template requires upgrade', type : 'boolean'}, {name : 'guestmacaddress', description : 'The guest MAC address for the router', type : 'string'}, {name : 'ip6dns2', description : 'The second IPv6 DNS for the router', type : 'string'}, {name : 'templateid', description : 'The Template ID for the router', type : 'string'}, {name : 'zonename', description : 'The Zone name for the router', type : 'string'}, {name : 'dns1', description : 'The first DNS for the router', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the router', type : 'string'}, {name : 'softwareversion', description : 'The version of the code / software in the router', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the router belongs to', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the router', type : 'string'}, {}, {name : 'dns2', description : 'The second DNS for the router', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'redundantstate', description : 'The state of redundant virtual router', type : 'string'}, {name : 'role', description : 'Role of the domain router', type : 'string'}, {name : 'healthcheckresults', description : 'Last executed health check result for the router', type : 'list', response : [{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 : 'checkname', description : 'The name of the health check on the router', type : 'string'}, {name : 'details', description : 'Detailed response generated on running health check', type : 'string'}, {name : 'checktype', description : 'The type of the health check - basic or advanced', type : 'string'}, {name : 'status', description : 'the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}', type : 'routerhealthstatus'}]}, {name : 'podid', description : 'The Pod ID for the router', type : 'string'}, {name : 'state', description : 'The state of the router', type : 'state'}, {name : 'hostcontrolstate', description : 'The control state of the host for the router', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'guestipaddress', description : 'The guest IP address for the router', type : 'string'}, {name : 'arch', description : 'CPU arch of the router', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the router', type : 'string'}, {name : 'ip6dns1', description : 'The first IPv6 DNS for the router', 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 router', type : 'string'}, {}, {name : 'podname', description : 'The Pod name for the router', type : 'string'}, {name : 'id', description : 'The ID of the router', type : 'string'}, {name : 'vpcid', description : 'VPC the router belongs to', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'project', description : 'The project name of the address', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteUserData', description : 'Deletes a userdata', since : '4.18', isasync : False, params : [{name : 'account', description : 'An optional account for the userdata. Must be used with domainId.', type : 'string', length : 255, required : False}, {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 : '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 : ''}], 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 : 'listVmsForImport', description : 'Lists virtual machines on a unmanaged host', since : '4.19.0', isasync : False, related : 'listVmwareDcVms,listUnmanagedInstances', params : [{name : 'host', description : 'the host name or IP address', type : 'string', length : 255, required : True}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'username', description : 'the username for the host', type : 'string', length : 255, required : False}, {name : 'password', description : 'the password for the host', type : 'string', length : 255, required : False}, {name : 'hypervisor', description : 'hypervisor type of the host', type : 'string', length : 255, required : True}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'clustername', description : 'the name of the cluster to which virtual machine belongs', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'disk', description : 'The list of disks associated with the Instance', type : 'set', response : [{name : 'capacity', description : 'The capacity of the disk in bytes', type : 'long'}, {name : 'controller', description : 'The controller of the disk', type : 'string'}, {name : 'imagepath', description : 'The file path of the disk image', type : 'string'}, {name : 'datastoretype', description : 'The controller of the disk', type : 'string'}, {name : 'position', description : 'The position of the disk', type : 'integer'}, {name : 'datastorehost', description : 'The controller of the disk', type : 'string'}, {name : 'label', description : 'The label of the disk', type : 'string'}, {name : 'datastorename', description : 'The controller of the disk', type : 'string'}, {name : 'id', description : 'The ID 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 : 'clusterid', description : 'The ID of the cluster to which Instance belongs', type : 'string'}, {name : 'cpuspeed', description : 'The CPU speed of the Instance', 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 : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'osdisplayname', description : 'The operating system of the Instance', type : 'string'}, {}, {name : 'nic', description : 'The list of NICs associated with the Instance', type : 'set', response : [{name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', 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 : 'networkid', description : 'The ID of the corresponding Network', 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 : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', 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 : '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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', 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 : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {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 : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}]}, {name : 'hypervisor', description : 'The hypervisor to which Instance belongs', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'memory', description : 'The memory of the Instance in MB', type : 'integer'}, {}, {name : 'osid', description : 'The operating system ID of the Instance', type : 'string'}, {name : 'boottype', description : 'indicates the boot type', type : 'string'}, {name : 'powerstate', description : 'The power state of the Instance', type : 'string'}, {name : 'bootmode', description : 'indicates the boot mode', type : 'string'}, {name : 'hostid', description : 'The ID of the host to which Instance belongs', type : 'string'}, {name : 'cpucorepersocket', description : 'The CPU cores per socket for the Instance. VMware specific', type : 'integer'}, {name : 'hostname', description : 'The name of the host to which Instance belongs', 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 : '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 : 'listProjectRoles', description : 'Lists Project roles in CloudStack', since : '4.15.0', isasync : False, related : 'updateProjectRole', params : [{name : 'projectid', description : 'List project role by project ID.', type : 'uuid', length : 255, required : True, related : ''}, {name : 'name', description : 'List project role by project role name.', 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 : '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 role', type : 'string'}, {name : 'description', description : 'The description of the role', type : 'string'}, {name : 'id', description : 'The ID of the role', 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 : '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'}], httprequesttype : 'GET'}, {name : 'restoreBackup', description : 'Restores an existing stopped or deleted Instance using an Instance backup', since : '4.14.0', isasync : True, params : [{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 : '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 : 'id', description : 'ID of the backup', 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 : '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 : 'listDnsZones', description : 'Lists DNS zones.', since : '4.23.0', isasync : False, related : '', params : [{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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'List DNS zone by ID', type : 'uuid', length : 255, required : False, related : 'listDnsZones'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'domain', description : 'the name of the domain associated with the DNS zone', type : 'string'}, {name : 'networkid', description : 'ID of the network this zone is associated with', type : 'string'}, {name : 'dnsservername', description : 'the name of the DNS server hosting this zone', type : 'string'}, {name : 'id', description : 'ID of the DNS zone', type : 'string'}, {name : 'networkname', description : 'Name of the network this zone is associated with', 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 DNS zone', type : 'string'}, {name : 'type', description : 'The type of the zone (Public/Private)', type : 'zonetype'}, {}, {name : 'dnsserverid', description : 'ID of the DNS server this zone belongs to', type : 'string'}, {name : 'dnsserveraccount', description : 'the account name of the DNS server owner', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'description', description : 'Description for the DNS zone', type : 'string'}, {}, {name : 'state', description : 'The state of the zone (Active/Inactive)', type : 'state'}, {name : 'account', description : 'the account associated with the DNS zone', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the DNS server', type : 'string'}], httprequesttype : 'GET'}, {name : 'listInstanceBootGroupMembers', description : 'Lists members of an Instance Boot Group, sorted by boot order', since : '24.0', isasync : False, related : 'addMemberToInstanceBootGroup', params : [{name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'ignoreinstancestate', description : "If true, readiness status/message reflect the last cached rule check regardless of the member's current instance state. If false (default), an Instance that isn't Running is always reported NotReady, even if its rules were last cached Ready", type : 'boolean', length : 255, required : False}, {name : 'membertype', description : 'Filter by member type: VirtualMachine or InstanceGroup', type : 'string', length : 255, required : False}, {name : 'bootgroupid', description : 'The ID of the Instance Boot Group', type : 'uuid', length : 255, required : True, related : 'stopInstanceBootGroup,rebootInstanceBootGroup'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'details', description : 'Comma separated list of additional details requested, value can be a list of [all, readiness, children]. Readiness fields are computed from cached check results (not a live re-check) and are omitted unless requested, since computing them is not free. Children returns the member Instances of InstanceGroup-type members (omitted for VirtualMachine-type members); combine with readiness to also include per-child readiness', type : 'list', length : 255, required : False}], response : [{name : 'order', description : 'The boot order value for this member', type : 'int'}, {name : 'membertype', description : 'The type of the member: VirtualMachine or InstanceGroup', type : 'string'}, {}, {name : 'readinessmode', description : 'None, CHILD_DEPENDENT or RULE_BASED, computed from whether readiness rules are attached', 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 this member entry', type : 'string'}, {name : 'bootgroupid', description : 'The ID of the boot group this member belongs to', type : 'string'}, {name : 'readinessmessage', description : "Why readinessstatus is what it is: the failing rule(s)' cached message, and/or a count of not-ready member VMs for InstanceGroup members", type : 'string'}, {name : 'membername', description : 'The name of the VM or InstanceGroup', type : 'string'}, {name : 'memberid', description : 'The ID of the VM or InstanceGroup', type : 'string'}, {name : 'children', description : 'For InstanceGroup members, the VMs within the group (only present when requested via details=children)', type : 'list'}, {name : 'created', description : 'The date the member was added to the boot group', type : 'date'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'memberstate', description : 'The state of the Instance', type : 'string'}, {name : 'readinessstatus', description : 'The last cached readiness evaluation', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateVmNic', description : 'Updates the specified VM NIC', isasync : True, related : '', params : [{name : 'nicid', description : 'NIC ID', type : 'uuid', length : 255, required : True, related : 'updateVmNic'}, {name : 'enabled', description : 'If true, sets the NIC state to UP; otherwise, sets the NIC state to DOWN', type : 'boolean', length : 255, required : False}], response : [{name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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 : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', 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 : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'gateway', description : 'The gateway 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 : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', 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 : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {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 : '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 : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {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 : 'vpcname', description : 'Name of the VPC to which the NIC belongs', 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 : 'cniconfig', description : 'CNI Configuration content to be registered as User data', type : 'string', length : 1048576, required : False}, {name : 'projectid', description : 'an optional project for the user data', type : 'uuid', length : 255, required : False, related : ''}, {name : 'params', description : 'comma separated list of variables declared in user data content', type : 'string', length : 255, required : False}, {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 : 'account', description : 'an optional account for the user data. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'name', description : 'Name of the user data', 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 : '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 : '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 : '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 : '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 : '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}, {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 : ''}], response : [{name : 'status', description : 'The status of the Template', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {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 : 'passwordenabled', description : 'True if the reset password feature is enabled, false otherwise', type : 'boolean'}, {name : 'isextractable', description : 'True if the Template is extractable, false otherwise', type : 'boolean'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}, {name : 'accountid', description : 'The Account id to which the Template belongs', type : 'string'}, {name : 'userdataname', description : 'The name of userdata linked to this Template', type : 'string'}, {name : 'id', description : 'The Template ID', type : 'string'}, {name : 'ostypeid', description : 'The ID of the OS type for this Template.', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'removed', description : 'The date this Template was removed', type : 'date'}, {name : 'crossZones', description : 'True if the Template is managed across all Zones, false otherwise', type : 'boolean'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}, {name : 'project', description : 'The project name of the Template', type : 'string'}, {name : 'bits', description : 'The processor bit size', type : 'int'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean'}, {name : 'account', description : 'The Account name to which the Template belongs', 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 : 'hostid', description : 'The ID of the secondary storage host for the Template', type : 'string'}, {name : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'zonename', description : 'The name of the zone for this Template', 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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer 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 : 'value', description : 'Tag value', 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 : 'resourcetype', description : 'Resource type', 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 : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'parenttemplateid', description : 'If Datadisk Template, then id of the root disk Template this Template belongs to', type : 'string'}, {name : 'domain', description : 'The name of the domain to which the Template belongs', type : 'string'}, {name : 'directdownload', description : 'KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage', type : 'boolean'}, {name : 'extensionid', description : 'The ID of extension linked to this template', type : 'string'}, {name : 'userdataid', description : 'The id of userdata linked to this Template', type : 'string'}, {name : 'name', description : 'The Template name', type : 'string'}, {name : 'hostname', description : 'The name of the secondary storage host for the Template', type : 'string'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {name : 'format', description : 'The format of the Template.', type : 'imageformat'}, {name : 'size', description : 'The size of the Template', type : 'long'}, {name : 'arch', description : 'CPU Arch of the template', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', 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 : 'extensionname', description : 'The name of extension linked to this template', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', 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 : 'domainid', description : 'The ID of the domain to which the Template belongs', type : 'string'}, {name : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {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 : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {name : 'displaytext', description : 'The Template display text', type : 'string'}, {name : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {}, {name : 'checksum', description : 'Checksum of the Template', type : 'string'}], httprequesttype : 'POST'}, {name : 'listCustomActions', description : 'Lists the custom actions', since : '4.21.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 : 'resourcetype', description : 'Type of the resource for actions', type : 'string', length : 255, required : False}, {name : 'name', description : 'Name of the custom action', type : 'string', length : 255, required : False}, {name : 'resourceid', description : 'ID of a resource for actions', type : 'string', length : 255, required : False}, {name : 'extensionid', description : 'uuid of the extension', type : 'uuid', length : 255, required : False, related : 'listExtensions,updateExtension'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'uuid of the custom action', type : 'uuid', length : 255, required : False, related : 'listCustomActions'}, {name : 'enabled', description : 'List actions whether they are enabled or not', type : 'boolean', length : 255, required : False}], response : [{name : 'name', description : 'Name of the custom action', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'created', description : 'Creation timestamp of the custom action', type : 'date'}, {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'}, {name : 'extensionname', description : 'Name of the extension that this custom action belongs to', type : 'string'}, {name : 'timeout', description : 'Specifies the timeout in seconds to wait for the action to complete before failing', type : 'integer'}, {name : 'id', description : 'ID of the custom action', type : 'string'}, {name : 'enabled', description : 'Whether the custom action is enabled or not', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'details', description : 'Details of the custom action', type : 'map'}, {name : 'resourcetype', description : 'Resource type for which the action is available', type : 'string'}, {name : 'allowedroletypes', description : 'List of role types allowed for the custom action', type : 'list'}, {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 : 'name', description : 'Name of the parameter', type : 'string'}, {name : 'type', description : 'Type of the parameter', type : 'string'}, {name : 'valueoptions', description : 'Comma-separated list of options for value of the parameter', type : 'list'}, {name : 'required', description : 'Whether the parameter is required or not', type : 'boolean'}, {name : 'validationformat', description : 'Validation format for value of the parameter. Available for specific types', type : 'string'}]}, {name : 'description', description : 'Description of the custom 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 : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'name', description : 'Name of the container cluster', type : 'string'}, {name : 'configdata', description : 'The config data of the cluster', 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 container cluster', type : 'string'}], 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 : '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 : 'listInternalLoadBalancerVMs', description : 'List internal LB Instances.', isasync : False, related : 'listRouters', params : [{name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'zoneid', description : 'The Zone ID of the Internal LB Instance', type : 'uuid', length : 255, required : False, related : 'listZones'}, {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 : '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 : '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 : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'forvpc', description : 'If true is passed for this parameter, list only VPC Internal LB Instances', type : 'boolean', 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'}, {name : 'name', description : 'The name of the Internal LB Instance', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'state', description : 'The state of the Internal LB Instance', type : 'string', 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 : 'vpcid', description : 'List Internal LB Instances by VPC', type : 'uuid', length : 255, required : False, related : 'listVPCs,createVPC,listVPCs,updateVPC'}, {name : 'podid', description : 'The Pod ID of the Internal LB Instance', type : 'uuid', length : 255, required : False, related : 'createManagementNetworkIpRange'}, {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 : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork'}], response : [{name : 'redundantstate', description : 'The state of redundant virtual router', type : 'string'}, {name : 'templatename', description : 'The Template name for the router', type : 'string'}, {name : 'guestnetworkname', description : 'The name of the corresponding guest Network', type : 'string'}, {name : 'created', description : 'The date and time the router was created', type : 'date'}, {name : 'vpcid', description : 'VPC the router belongs to', type : 'string'}, {name : 'name', description : 'The name of the router', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the router', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the router', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the router belongs to', type : 'string'}, {name : 'isredundantrouter', description : 'If this router is an redundant virtual router', type : 'boolean'}, {name : 'guestipaddress', description : 'The guest IP address for the router', type : 'string'}, {name : 'dns1', description : 'The first DNS for the router', type : 'string'}, {name : 'project', description : 'The project name of the address', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with the router', type : 'set', response : [{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 : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {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 : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', 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 : 'vpcname', description : 'Name of the VPC to which the NIC belongs', 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 : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'networkid', description : 'The ID of the corresponding 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 : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {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 : 'macaddress', description : 'True if NIC is default, false otherwise', 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 : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}]}, {name : 'dns2', description : 'The second DNS for the router', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the router', type : 'string'}, {name : 'vpcname', description : 'The name of VPC the router belongs to', type : 'string'}, {name : 'state', description : 'The state of the router', type : 'state'}, {name : 'arch', description : 'CPU arch of the router', type : 'string'}, {}, {name : 'gateway', description : 'The gateway for the router', type : 'string'}, {name : 'hostid', description : 'The host ID for the router', type : 'string'}, {name : 'healthchecksfailed', description : 'True if any health checks had failed', type : 'boolean'}, {name : 'publicmacaddress', description : 'The public MAC address for the router', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'templateid', description : 'The Template ID for the router', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the router', type : 'string'}, {name : 'podname', description : 'The Pod name for the router', type : 'string'}, {name : 'requiresupgrade', description : 'True if the router Template requires upgrade', type : 'boolean'}, {name : 'domain', description : 'The domain associated with the router', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'role', description : 'Role of the domain router', type : 'string'}, {name : 'guestnetmask', description : 'The guest netmask for the router', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'ip6dns1', description : 'The first IPv6 DNS for the router', type : 'string'}, {name : 'linklocalnetworkid', description : 'The ID of the corresponding link local Network', type : 'string'}, {name : 'healthcheckresults', description : 'Last executed health check result for the router', type : 'list', response : [{name : 'status', description : 'the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}', type : 'routerhealthstatus'}, {name : 'lastupdated', description : 'The date this VPC was created', type : 'date'}, {name : 'checkname', description : 'The name of the health check on the router', type : 'string'}, {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 : 'checktype', description : 'The type of the health check - basic or advanced', type : 'string'}]}, {name : 'version', description : 'The version of Template', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'domainid', description : 'The domain ID associated with the router', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the router', type : 'string'}, {name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {name : 'publicnetworkid', description : 'The ID of the corresponding public Network', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the router', type : 'string'}, {name : 'zonename', description : 'The Zone name for the router', type : 'string'}, {name : 'publicip', description : 'The public IP address for the router', type : 'string'}, {name : 'account', description : 'The Account associated with the router', type : 'string'}, {}, {name : 'id', description : 'The ID of the router', type : 'string'}, {name : 'scriptsversion', description : 'The version of scripts', type : 'string'}, {name : 'ip6dns2', description : 'The second IPv6 DNS for the router', type : 'string'}, {name : 'softwareversion', description : 'The version of the code / software in the router', type : 'string'}, {name : 'guestmacaddress', description : 'The guest MAC address for the router', type : 'string'}, {name : 'guestnetworkid', description : 'The ID of the corresponding guest Network', type : 'string'}, {name : 'hostname', description : 'The hostname for the router', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the router', type : 'string'}, {name : 'podid', description : 'The Pod ID for the router', type : 'string'}], httprequesttype : 'GET'}, {name : 'uploadResourceIcon', description : 'Uploads an icon for the specified resource(s)', since : '4.16.0.0', isasync : False, 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}, {name : 'base64image', description : 'Base64 string representation of the resource icon/image', type : 'string', length : 2097152, required : True}], 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 : 'listHSMProfiles', description : 'Lists HSM profiles', since : '4.23.0', isasync : False, related : '', params : [{name : 'id', description : 'the HSM profile ID', type : 'uuid', length : 255, required : False, related : 'listHSMProfiles'}, {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 : 'keyword', description : 'List by keyword', 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 : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', 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 : 'protocol', description : 'the protocol of the HSM profile', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'enabled', description : 'list only enabled 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 : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}], response : [{name : 'id', description : 'the ID of the HSM profile', type : 'string'}, {name : 'project', description : 'the project name of the HSM profile owner', type : 'string'}, {name : 'ispublic', description : 'whether this is a system HSM profile available to all users globally', type : 'boolean'}, {name : 'domainpath', description : 'the domain path of the HSM profile owner', type : 'string'}, {}, {name : 'protocol', description : 'the protocol of the HSM profile', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'vendor', description : 'the vendor name of the HSM profile', type : 'string'}, {name : 'state', description : 'the state of the HSM profile', type : 'string'}, {}, {name : 'name', description : 'the name of the HSM profile', type : 'string'}, {name : 'zonename', description : 'the zone name where the HSM profile is available', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'details', description : 'HSM configuration details (sensitive values are encrypted)', type : 'map'}, {name : 'accountid', description : 'the account ID of the HSM profile owner', type : 'string'}, {name : 'zoneid', description : 'the zone ID where the HSM profile is available', type : 'string'}, {name : 'domain', description : 'the domain name of the HSM profile owner', type : 'string'}, {name : 'created', description : 'the date the HSM profile was created', type : 'date'}, {name : 'account', description : 'the account name of the HSM profile owner', type : 'string'}, {name : 'domainid', description : 'the domain ID of the HSM profile owner', type : 'string'}, {name : 'enabled', description : 'whether the HSM profile is enabled', type : 'boolean'}, {name : 'projectid', description : 'the project ID of the HSM profile owner', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateAutoScaleVmProfile', description : 'Updates an existing autoscale Instance profile.', isasync : True, related : 'listAutoScaleVmProfiles', params : [{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 : 'serviceofferingid', description : 'The service offering of the auto deployed  Instance', type : 'uuid', length : 255, required : False, since : '4.18.0', related : 'updateServiceOffering,listServiceOfferings'}, {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 : '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 : '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 : 'userdataid', description : 'the ID of the userdata', type : 'uuid', length : 255, required : False, since : '4.18.1', related : ''}, {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'}, {name : 'id', description : 'The ID of the autoscale Instance profile', type : 'uuid', length : 255, required : True, related : 'listAutoScaleVmProfiles,updateAutoScaleVmProfile'}, {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 : '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 : '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 : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer', length : 255, required : False}], response : [{name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance', type : 'map'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer'}, {name : 'userdata', description : 'Base64 encoded Instance user data', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'zoneid', description : 'The availability zone to be used while deploying an Instance', type : 'string'}, {name : 'templateid', description : 'The Template 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'}, {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 : 'userdatapolicy', description : 'the userdata override policy with the userdata provided while deploying VM', type : 'string'}, {name : 'fordisplay', description : 'Is profile for display to the regular User', type : 'boolean'}, {name : 'id', description : 'The autoscale Instance profile ID', type : 'string'}, {}, {}, {}, {name : 'projectid', description : 'The project id Instance profile', type : 'string'}, {name : 'serviceofferingid', description : 'The service offering to be used while deploying an Instance', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance profile', type : 'string'}, {name : 'userdataid', description : 'the id of userdata used for the VM', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance profile', type : 'string'}, {name : 'userdataname', description : 'the name of userdata used for the VM', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the vm profile belongs', type : 'string'}, {name : 'userdatadetails', description : 'list of variables and values for the variables declared in userdata', type : 'string'}, {name : 'project', description : 'The project name of the Instance profile', 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 : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {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 : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'project', description : 'The project name of the Instance group', type : 'string'}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}, {name : 'state', description : 'The current state of the AutoScale Instance Group', 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 : 'publicipid', description : 'The public IP address ID', 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 Instance group', type : 'string'}, {name : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance group', type : 'string'}, {name : 'created', description : 'The date when this Instance group was created', type : 'date'}, {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 : '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 : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {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'}, {name : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteWebhookDelivery', description : 'Deletes Webhook delivery', since : '4.20.0', isasync : False, params : [{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 : '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 : 'id', description : 'The ID of the Webhook delivery', type : 'uuid', length : 255, required : False, related : ''}, {name : 'managementserverid', description : 'The ID of the management server', 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 : 'listVmwareDcVms', description : 'Lists the VMs in a VMware Datacenter', isasync : False, related : 'listUnmanagedInstances', params : [{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 : 'keyword', description : 'List by keyword', type : 'string', 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 : 'existingvcenterid', description : 'UUID of a linked existing vCenter', type : 'uuid', length : 255, required : False, related : ''}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'password', description : 'The password for specified username.', type : 'string', length : 255, required : False}, {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 : 'datacentername', description : 'Name of VMware datacenter.', type : 'string', length : 255, required : False}], response : [{name : 'osid', description : 'The operating system ID of the Instance', type : 'string'}, {name : 'osdisplayname', description : 'The operating system of the Instance', type : 'string'}, {}, {name : 'cpucorepersocket', description : 'The CPU cores per socket for the Instance. VMware specific', type : 'integer'}, {name : 'memory', description : 'The memory of the Instance in MB', type : 'integer'}, {name : 'clusterid', description : 'The ID of the cluster to which Instance belongs', type : 'string'}, {name : 'clustername', description : 'the name of the cluster to which virtual machine belongs', 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 : 'disk', description : 'The list of disks associated with the Instance', type : 'set', response : [{name : 'label', description : 'The label of the disk', type : 'string'}, {name : 'controller', description : 'The controller of the disk', type : 'string'}, {name : 'datastorepath', description : 'The controller of the disk', type : 'string'}, {name : 'datastorename', description : 'The controller of the disk', type : 'string'}, {name : 'imagepath', description : 'The file path of the disk image', type : 'string'}, {name : 'datastorehost', description : 'The controller of the disk', type : 'string'}, {name : 'id', description : 'The ID of the disk', type : 'string'}, {name : 'capacity', description : 'The capacity of the disk in bytes', type : 'long'}, {name : 'controllerunit', description : 'The controller unit of the disk', type : 'integer'}, {name : 'position', description : 'The position of the disk', type : 'integer'}, {name : 'datastoretype', description : 'The controller of the disk', type : 'string'}]}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor to which Instance belongs', type : 'string'}, {name : 'boottype', description : 'indicates the boot type', type : 'string'}, {name : 'cpuspeed', description : 'The CPU speed of the Instance', type : 'integer'}, {name : 'hypervisorversion', description : 'The hypervisor version of the host to which Instance belongs', type : 'string'}, {name : 'hostname', description : 'The name of the host to which Instance belongs', type : 'string'}, {name : 'hostid', description : 'The ID of the host to which Instance belongs', type : 'string'}, {name : 'bootmode', description : 'indicates the boot mode', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'cpunumber', description : 'The CPU cores of the Instance', type : 'integer'}, {}, {name : 'nic', description : 'The list of NICs associated with the Instance', type : 'set', response : [{name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {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 : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {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 : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {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 : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', 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 : 'vpcname', description : 'Name of the VPC to which the NIC belongs', 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 : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}]}], 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 : 'apikey', description : 'The API key of the registered user', 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 : 'secretkey', description : 'The secret key of the registered user', type : 'string'}, {name : 'apikeyaccess', description : 'Whether API key access is allowed or not', type : 'boolean'}, {}], httprequesttype : 'GET'}, {name : 'deleteInstanceBootGroup', description : 'Deletes an Instance Boot Group', since : '24.0', isasync : False, params : [{name : 'id', description : 'The ID of the Instance Boot Group', type : 'uuid', length : 255, required : True, related : 'stopInstanceBootGroup,rebootInstanceBootGroup'}], 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 : 'rebootInstanceBootGroup', description : 'Reboots all VMs in an Instance Boot Group: stops in reverse order then starts in forward order', since : '24.0', isasync : True, related : 'stopInstanceBootGroup', params : [{name : 'forced', description : 'Whether to force stop every Instance in the Instance Boot Group during the stop phase of the reboot (It is force-stopped and then started)', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The ID of the Instance Boot Group', type : 'uuid', length : 255, required : True, related : 'stopInstanceBootGroup,rebootInstanceBootGroup'}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'created', description : 'The date the instance boot group was created', type : 'date'}, {name : 'name', description : 'The name of the instance boot group', type : 'string'}, {name : 'accountid', description : 'The account ID owning the instance boot group', type : 'string'}, {name : 'domainpath', description : 'The path of the domain the instance boot group belongs to', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'domain', description : 'The domain name of the instance boot group', type : 'string'}, {name : 'id', description : 'The ID of the instance boot group', type : 'string'}, {name : 'account', description : 'The account owning the instance boot group', type : 'string'}, {name : 'project', description : 'The project name of the instance boot group', type : 'string'}, {name : 'readinessinitialdelayseconds', description : 'Effective delay in seconds after starting or rebooting an instance before its first readiness check of that attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'readinessattempttimeoutseconds', description : 'Effective timeout in seconds for each readiness retry attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'description', description : 'The description of the instance boot group', type : 'string'}, {name : 'readinessmaxretryattempts', description : 'Effective maximum number of readiness retry attempts (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'readinessrebootonretry', description : 'Effective setting for whether an instance is rebooted between readiness retry attempts (per-boot-group override if set, else the global default)', type : 'boolean'}, {name : 'projectid', description : 'The project ID of the instance boot group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the instance boot group', type : 'string'}], httprequesttype : 'POST'}, {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 : 'keybits', description : 'Key size for new KEK (default: same as current)', type : 'integer', length : 255, required : False}, {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 : 'id', description : 'KMS Key UUID to rotate', type : 'uuid', length : 255, required : True, related : 'createKMSKey,updateKMSKey'}], response : [{name : 'jobresulttype', description : 'The result type', type : 'string'}, {name : 'account', description : 'The Account that executed the async command', type : 'string'}, {name : 'domainid', description : 'The domain ID that executed the async command', type : 'string'}, {name : 'managementservername', description : 'the management server name of the host', type : 'string'}, {name : 'completed', description : 'The completed date of the job', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobprocstatus', description : 'The progress information of the PENDING job', type : 'integer'}, {name : 'jobinstancetype', description : 'The Instance/entity object related to the job', type : 'string'}, {}, {name : 'created', description : 'The created date of the job', type : 'date'}, {name : 'jobresultcode', description : 'The result code for the job', type : 'integer'}, {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 : 'accountid', description : 'The Account ID that executed the async command', type : 'string'}, {name : 'userid', description : 'The User that executed the async command', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'managementserverid', description : 'The MSID of the management server on which the job is running', type : 'string'}, {name : 'domainpath', description : 'The domain that executed the async command', type : 'string'}, {name : 'cmd', description : 'The async command executed', type : 'string'}], httprequesttype : 'POST'}, {name : 'addMemberToInstanceBootGroup', description : 'Adds an Instance or instance group to an instance boot group. Exactly one of virtualmachineid or instancegroupid must be specified.', since : '24.0', isasync : False, related : '', params : [{name : 'virtualmachineid', description : 'The ID of the Instance to add (exclusive with instancegroupid)', 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 : 'instancegroupid', description : 'The ID of the Instance Group to add (exclusive with virtualmachineid)', type : 'uuid', length : 255, required : False, related : ''}, {name : 'id', description : 'The ID of the instance boot group', type : 'uuid', length : 255, required : True, related : 'stopInstanceBootGroup'}, {name : 'order', description : 'The boot order value for this member (0 or greater; non-contiguous values are allowed). Any existing member already at or past this value is shifted one slot later to make room', type : 'integer', length : 255, required : True}], response : [{name : 'bootgroupid', description : 'The ID of the boot group this member belongs to', type : 'string'}, {name : 'readinessmessage', description : "Why readinessstatus is what it is: the failing rule(s)' cached message, and/or a count of not-ready member VMs for InstanceGroup members", type : 'string'}, {name : 'membername', description : 'The name of the VM or InstanceGroup', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'order', description : 'The boot order value for this member', type : 'int'}, {name : 'readinessstatus', description : 'The last cached readiness evaluation', type : 'string'}, {name : 'readinessmode', description : 'None, CHILD_DEPENDENT or RULE_BASED, computed from whether readiness rules are attached', type : 'string'}, {}, {name : 'id', description : 'The UUID of this member entry', type : 'string'}, {name : 'memberstate', description : 'The state of the Instance', type : 'string'}, {name : 'memberid', description : 'The ID of the VM or InstanceGroup', type : 'string'}, {name : 'created', description : 'The date the member was added to the boot group', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'membertype', description : 'The type of the member: VirtualMachine or InstanceGroup', type : 'string'}, {name : 'children', description : 'For InstanceGroup members, the VMs within the group (only present when requested via details=children)', type : 'list'}], httprequesttype : 'POST'}, {name : 'changeSharedFileSystemServiceOffering', description : 'Change Service offering of a Shared FileSystem', since : '4.20.0', isasync : True, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering', params : [{name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}, {name : 'serviceofferingid', description : 'the offering to use for the shared filesystem instance', type : 'uuid', length : 255, required : True, related : 'updateServiceOffering,listServiceOfferings'}], response : [{}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', 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 : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', 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 : '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 : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', 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 : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {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 : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', 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 : 'ip6cidr', description : 'The CIDR of IPv6 Network', 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 : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', 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 : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'networkid', description : 'The ID 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 : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}]}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'domainpath', description : 'path of the domain to which 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 : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{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 : 'key', description : 'Tag key name', 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 : 'customer', description : 'Customer 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 : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}], httprequesttype : 'POST'}, {name : 'cloudianIsEnabled', description : 'Checks if the Cloudian Connector is enabled', since : '4.11.0', isasync : False, related : '', 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 : 'enabled', description : 'The Cloudian connector enabled state', type : 'boolean'}, {name : 'url', description : 'The Cloudian Management Console base URL', type : 'string'}, {}], httprequesttype : 'GET'}, {name : 'copySnapshot', description : 'Copies a snapshot from one zone to another.', since : '4.19.0', isasync : True, related : 'listSnapshots', params : [{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'}, {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 : '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 : 'id', description : 'the ID of the snapshot.', type : 'uuid', length : 255, required : True, related : 'copySnapshot,listSnapshots'}], response : [{name : 'physicalsize', description : 'Physical size of backed up Snapshot on image store', type : 'long'}, {name : 'volumetype', description : 'Type of the disk volume', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'ostypeid', description : 'ID of the os on volume', type : 'string'}, {name : 'locationtype', description : 'Valid location types are primary and secondary.', type : 'string'}, {name : 'status', description : 'the status of the template', type : 'string'}, {name : 'datastoreid', description : 'ID of the datastore for the snapshot entry', type : 'string'}, {name : 'id', description : 'ID of the Snapshot', 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 : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourceid', description : 'ID of the resource', 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 : 'account', description : 'The Account 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 : '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 : '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 : 'osdisplayname', description : 'Display name of the os on volume', type : 'string'}, {name : 'project', description : 'The project name of the Snapshot', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'domainid', description : "The domain ID of the Snapshot's Account", type : 'string'}, {name : 'domainpath', description : "path of the Domain the snapshot's account belongs to", type : 'string'}, {name : 'snapshottype', description : 'The type of the Snapshot', 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 disk volume', type : 'string'}, {name : 'parentname', description : 'The parent name of the Snapshot', type : 'string'}, {name : 'revertable', description : 'Indicates whether the underlying storage supports reverting the volume to this Snapshot', type : 'boolean'}, {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 : 'virtualsize', description : 'Virtual size of backedup Snapshot on image store', type : 'long'}, {name : 'downloaddetails', description : 'download progress of a snapshot', type : 'map'}, {name : 'projectid', description : 'The project id of the Snapshot', type : 'string'}, {name : 'name', description : 'Name of the Snapshot', type : 'string'}, {name : 'zonename', description : 'name of the availability zone', type : 'string'}, {}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'volumestate', description : 'state of the disk volume', type : 'string'}, {name : 'volumeid', description : 'ID of the disk volume', type : 'string'}, {name : 'datastorestate', description : 'state of the snapshot on the datastore', type : 'string'}, {}, {name : 'account', description : 'The Account associated with the Snapshot', type : 'string'}, {name : 'domain', description : "The domain name of the Snapshot's Account", type : 'string'}, {name : 'datastoretype', description : 'type of the datastore for the snapshot entry', type : 'string'}, {name : 'intervaltype', description : 'Valid types are hourly, daily, weekly, monthy, Template, and none.', type : 'string'}, {name : 'datastorename', description : 'name of the datastore for the snapshot entry', type : 'string'}], httprequesttype : 'POST'}, {name : 'createDnsRecord', description : 'Creates a DNS record directly on the provider', since : '4.23.0', isasync : True, related : '', params : [{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}, {name : 'type', description : 'DNS record type (e.g., A, AAAA, CNAME, MX, TXT, etc.)', type : 'string', length : 255, required : True}], response : [{name : 'contents', description : 'The contents of the record (IP address or target)', type : 'list'}, {}, {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'}, {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'}], httprequesttype : 'POST'}, {name : 'listSharedFileSystems', description : 'List Shared FileSystems', since : '4.20.0', isasync : False, related : 'changeSharedFileSystemDiskOffering', params : [{name : 'diskofferingid', description : 'the disk offering of the shared filesystem', type : 'uuid', length : 255, required : False, related : ''}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {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 : '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 ID of the shared filesystem', type : 'uuid', length : 255, required : False, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering'}, {name : 'name', description : 'the name of the shared filesystem', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'the ID of the availability zone', type : 'uuid', length : 255, required : False, related : 'listZones'}, {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 : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", 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 : 'page', 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 : ''}, {name : 'networkid', description : 'the ID of the network', type : 'uuid', length : 255, required : False, related : 'createNetwork,updateNetwork,listNetworks,migrateNetwork'}, {name : 'serviceofferingid', description : 'the service offering of the shared filesystem', type : 'uuid', length : 255, required : False, related : 'updateServiceOffering,listServiceOfferings'}], response : [{name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', 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 : 'provisioningtype', description : 'provisioning type used in the shared filesystem', 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 : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'id', description : 'The ID 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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'ip6address', description : 'The IPv6 address of Network', 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 : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {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 : '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 : '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 : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', 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 : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {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 : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {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 : 'vpcid', description : 'ID of the VPC to which the NIC belongs', 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 : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}]}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', 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 : 'serviceofferingid', description : 'service offering ID for 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 : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'project', description : 'The project name where tag belongs to', 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 : '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 : '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 : 'resourcetype', description : 'Resource type', 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 : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', 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 : '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 : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', 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 : 'serviceofferingname', description : 'service offering for 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 : '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 : '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 : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', 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 : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone 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 : '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 : 'gateway', description : 'The gateway 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 : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'podid', description : 'The Pod ID 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 : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'id', description : 'The ID of 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 : '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 : 'format', description : 'The format for the Template. Possible values include QCOW2, RAW, VHD and OVA.', type : 'string', length : 255, required : True}, {name : 'account', description : 'An optional accountName. Must be used with domainId.', type : 'string', 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 : '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 : 'bits', description : '32 or 64 bits support. 64 by default', type : 'integer', 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 : 'passwordenabled', description : 'True if the Template supports the password reset feature; default is false', type : 'boolean', 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 : 'displaytext', description : "The display text of the Template, defaults to 'name'.", type : 'string', length : 4096, 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 : '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 : '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 : 'directdownload', description : 'True if Template should bypass Secondary Storage and be downloaded to Primary Storage on deployment', type : 'boolean', length : 255, required : False}, {name : 'extensionid', description : 'ID of the extension', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listExtensions'}, {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 : '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 : 'projectid', description : 'Register Template for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'url', description : 'The URL of where the Template is hosted. Possible URL include http:// and https://', type : 'string', length : 2048, required : True}, {name : 'ispublic', description : 'True if the Template is available to all accounts; default is true', type : 'boolean', 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 : '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 : 'forcks', description : 'if true, the templates would be available for deploying CKS clusters', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'name', description : 'The name of 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.19.0'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean', length : 255, required : False}, {name : 'hypervisor', description : 'The target hypervisor for the Template', type : 'string', length : 255, required : True}, {name : 'requireshvm', description : 'True if this Template requires HVM', type : 'boolean', length : 255, required : False}, {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'}], response : [{name : 'displaytext', description : 'The Template display text', type : 'string'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {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 : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'requireshvm', description : 'True if Template requires HVM enabled, false otherwise', type : 'boolean'}, {}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {name : 'isready', description : 'True if the Template is ready to be deployed from, false otherwise.', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'bits', description : 'The processor bit size', type : 'int'}, {name : 'accountid', description : 'The Account id to which the Template belongs', type : 'string'}, {name : 'crossZones', description : 'True if the Template is managed across all Zones, false otherwise', type : 'boolean'}, {name : 'ispublic', description : 'True if this Template is a public Template, false otherwise', type : 'boolean'}, {name : 'account', description : 'The Account name to which the Template belongs', type : 'string'}, {name : 'status', description : 'The status of the Template', type : 'string'}, {name : 'id', description : 'The Template ID', type : 'string'}, {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 : 'removed', description : 'The date this Template was removed', type : 'date'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'url', description : 'The URL which the Template/ISO is registered from', type : 'string'}, {name : 'checksum', description : 'Checksum of the Template', type : 'string'}, {name : 'parenttemplateid', description : 'If Datadisk Template, then id of the root disk Template this Template belongs to', type : 'string'}, {name : 'extensionid', description : 'The ID of extension linked to this template', type : 'string'}, {name : 'templatetype', description : 'The type of the Template', type : 'string'}, {name : 'sshkeyenabled', description : 'True if Template is sshkey enabled, false otherwise', type : 'boolean'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'userdataname', description : 'The name of userdata linked to this Template', type : 'string'}, {name : 'userdataid', description : 'The id of userdata linked to this Template', type : 'string'}, {name : 'name', description : 'The Template name', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'sourcetemplateid', description : 'The Template ID of the parent Template if present', type : 'string'}, {name : 'passwordenabled', description : 'True if the reset password feature is enabled, false otherwise', type : 'boolean'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'ostypeid', description : 'The ID of the OS type for this Template.', type : 'string'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'isextractable', description : 'True if the Template is extractable, false otherwise', type : 'boolean'}, {name : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {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 : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean'}, {}, {name : 'zonename', description : 'The name of the zone for this Template', type : 'string'}, {name : 'templatetag', description : 'The tag of this Template', type : 'string'}, {name : 'hostid', description : 'The ID of the secondary storage host for the Template', type : 'string'}, {name : 'domain', description : 'The name of the domain to which the Template belongs', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying 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 : '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 : '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 : '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 : 'hostname', description : 'The name of the secondary storage host for the Template', type : 'string'}, {name : 'size', description : 'The size of the Template', type : 'long'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'project', description : 'The project name 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 : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', type : 'string'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listVirtualMachinesUsageHistory', description : 'Lists VM stats', since : '4.17', isasync : False, related : 'listSystemVmsUsageHistory', params : [{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 : '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 : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {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 : '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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{}, {}, {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 : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'stats', description : 'The list of Instance stats', type : 'list', response : [{name : 'memorytargetkbs', description : 'The target memory in Instance (KB)', type : 'long'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'memorykbs', description : 'The memory used by the Instance in KB', type : 'long'}, {name : 'cpuused', description : "The amount (percentage) of the Instance's CPU currently used", type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'networkwrite', description : 'The amount of uploaded data by the Instance in MiB', type : 'string'}, {name : 'memoryintfreekbs', description : "The Instance's free memory in KB or -1 if it cannot be gathered", type : 'long'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host 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 : 'networkread', description : 'The amount of downloaded data by the Instance in MiB', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {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 : 'diskiopstotal', description : 'The total disk IOPS since the last stats retrieval', type : 'long'}]}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'createKubernetesCluster', description : 'Creates a Kubernetes cluster', isasync : True, related : 'startKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'asnumber', description : 'the AS Number of the network', type : 'long', length : 255, required : False}, {name : 'externalloadbalanceripaddress', description : 'External load balancer IP address while using shared network with Kubernetes HA 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 : '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 : 'dockerregistryurl', description : 'URL for the docker image private registry', type : 'string', 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 : 'noderootdisksize', description : 'Root disk size in GB for each node', 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 : 'controlnodes', description : 'Number of Kubernetes cluster control nodes, default is 1', type : 'long', length : 255, required : False}, {name : 'dockerregistryusername', description : 'User name for the docker image private registry', 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. Example: nodetemplates[0].node='control'&nodetemplates[0].template='<template-uuid>'&nodetemplates[1].node='worker'&nodetemplates[1].template='<template-uuid>'", type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'dockerregistrypassword', description : 'Password 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 : 'keypair', description : 'Name of the SSH key pair used to login to the Instances', type : 'string', length : 255, required : False}, {name : 'description', description : 'Description for the Kubernetes cluster', type : 'string', 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'}, {name : 'name', description : 'Name for the Kubernetes cluster', type : 'string', length : 255, required : True}, {name : 'cniconfigurationid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.21.0', related : ''}, {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 : 'account', description : 'An optional Account for the Instance. Must be used with domainId.', type : 'string', length : 255, required : False}, {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 : '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 : '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 : 'size', description : 'Number of Kubernetes cluster worker nodes', type : 'long', length : 255, required : False}, {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 : 'projectid', description : 'Deploy cluster for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'nodeofferings', description : "(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter. Example: nodeofferings[0].node='control'&nodeofferings[0].offering='<service-offering-uuid>'&nodeofferings[1].node='worker'&nodeofferings[1].offering='<service-offering-uuid>'", type : 'map', 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'}], response : [{name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'templateid', description : 'The ID of the Template 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 : '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 : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {}, {name : 'zonename', description : 'The name of the zone 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 : 'serviceofferingid', description : 'The ID of the service offering 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 : 'controlofferingid', description : 'the ID 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 : 'state', description : 'The state 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 : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', 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 : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', 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 : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'size', description : 'The size (worker nodes count) of 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 : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'project', description : 'The project name 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 : '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'}, {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 : '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 : ''}], response : [{name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {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 : '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 : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}]}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', 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 : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {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 : 'group', description : 'The group name of the Instance', type : 'string'}, {}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'state', description : 'The state 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 : 'bootmode', description : 'Guest Instance Boot Mode', 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 : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {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 : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {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', type : 'set', response : [{name : 'value', description : 'Tag value', 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 : '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 : '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 : 'resourceid', description : 'ID of the resource', type : 'string'}]}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', 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 : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', 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 : '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 : 'name', description : 'The name of the attached ISO', type : 'string'}]}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', 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 : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {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 : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card 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 : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {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 : '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 : 'description', description : 'The description of the security 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 : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{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 : 'domain', description : '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 : 'resourceid', description : 'ID of the resource', 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 : 'projectid', description : 'The project ID the tag belongs to', 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 : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{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 : 'protocol', description : 'The protocol 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 : '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 : '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 : 'key', description : 'Tag key name', 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 : 'domainpath', description : 'Path of 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 : '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 : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', 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 : '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 : '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 : '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 : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}]}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {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 : 'account', description : 'Account owning 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 : '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 : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', 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 : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', 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 : '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 : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', 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 : '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 : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {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 : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {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 : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {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 : 'netmask', description : 'The netmask of the NIC', type : 'string'}]}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', 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 : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {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 : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {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 : 'POST'}, {name : 'updateWebhook', description : 'Updates a Webhook', since : '4.20.0', isasync : False, related : 'createWebhook', params : [{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 : 'scope', description : 'Scope of the Webhook', type : 'string', length : 255, required : False}, {name : 'payloadurl', description : 'Payload URL of the Webhook', type : 'string', length : 255, required : False}, {name : 'name', description : 'Name for 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'}, {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 : 'description', description : 'Description for the Webhook', type : 'string', length : 255, required : False}], response : [{name : 'created', description : 'The date when this Webhook was created', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {name : 'secretkey', description : 'The secret key for 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 : 'domain', description : 'The name of the domain in which the Webhook exists', type : 'string'}, {name : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'project', description : 'the project name of the Kubernetes cluster', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', 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'}, {}, {name : 'account', description : 'The account associated with the Webhook', type : 'string'}, {}, {name : 'description', description : 'The description of the Webhook', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}], 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 : 'certificate', description : 'The client certificate', type : 'string'}, {}, {name : 'privatekey', description : 'Private key for the certificate', type : 'string'}, {name : 'cacertificates', description : 'The CA certificate(s)', 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 : 'updateProjectRole', description : 'Creates a Project role', since : '4.15.0', isasync : False, related : '', params : [{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 : 'projectid', description : 'ID of project where role is being created', type : 'uuid', length : 255, required : True, related : ''}, {name : 'name', description : 'Creates a project role with this unique name', type : 'string', length : 255, required : False}], response : [{name : 'description', description : 'The description 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 : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'id', description : 'The ID of the role', type : 'string'}, {}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', 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 : 'accountid', description : 'the ID of the Account', type : 'uuid', length : 255, required : False, related : 'enableAccount,listAccounts'}, {name : 'convertinstancehostid', description : 'Conversion host of the importing task', type : 'uuid', length : 255, required : False, related : 'reconnectHost'}, {name : 'tasksfilter', description : 'Filter tasks by state, valid options are: All, Running, Completed, Failed', type : 'string', 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 : '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 : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'convertinstancehostname', description : 'the name of the host on which the instance is being converted', type : 'string'}, {name : 'step', description : 'the current step on the importing VM task', type : 'string'}, {name : 'convertinstancehostid', description : 'the ID of the host on which the instance is being converted', type : 'string'}, {name : 'stepduration', description : 'the duration of the current step', type : 'string'}, {name : 'created', description : 'the create date of the importing task', type : 'date'}, {name : 'zonename', description : 'the Zone name', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'sourcevmname', description : 'the source VM name', type : 'string'}, {name : 'displayname', description : 'the display name of the importing VM', type : 'string'}, {name : 'duration', description : 'the total task duration', type : 'string'}, {name : 'id', description : 'the ID of importing task', type : 'string'}, {name : 'accountid', description : 'the ID of account', type : 'string'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'datacentername', description : 'the datacenter name of the importing VM task', type : 'string'}, {name : 'description', description : 'the current step description on the importing VM task', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'zoneid', description : 'the Zone ID', type : 'string'}, {name : 'vcenter', description : 'the vcenter name of the importing VM task', type : 'string'}, {}, {name : 'virtualmachineid', description : 'the ID of the imported VM (after task is completed)', type : 'string'}, {name : 'state', description : 'the state of the importing VM task', type : 'string'}, {name : 'lastupdated', description : 'the last updated date of the importing task', type : 'date'}], httprequesttype : 'GET'}, {name : 'createKMSKey', description : 'Creates a new KMS key (Key Encryption Key) for encryption', since : '4.23.0', isasync : False, related : 'updateKMSKey', params : [{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 : '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 : 'name', description : 'Name of the KMS key', type : 'string', length : 255, required : True}, {name : 'projectid', description : 'ID of the project to create the KMS key for', type : 'uuid', length : 255, required : False, related : ''}, {name : 'zoneid', description : 'Zone ID where the key will be valid', type : 'uuid', length : 255, required : True, related : 'listZones'}], response : [{name : 'version', description : 'the key size in bits', type : 'integer'}, {name : 'hsmprofile', description : 'the zone name where the key is valid', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'hsmprofileid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'keybits', description : 'the key size in bits', type : 'integer'}, {name : 'id', description : 'the UUID of the key', type : 'string'}, {}, {name : 'project', description : 'the project name of the key', type : 'string'}, {name : 'accountid', description : 'the account ID owning the key', type : 'string'}, {name : 'domainid', description : 'the domain ID of the key', type : 'string'}, {name : 'zonename', description : 'the zone name where the key is valid', type : 'string'}, {name : 'description', description : 'the description of the key', type : 'string'}, {name : 'zoneid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'created', description : 'the creation timestamp', type : 'date'}, {}, {name : 'projectid', description : 'the project ID of the key', type : 'string'}, {name : 'algorithm', description : 'the encryption algorithm', type : 'string'}, {name : 'account', description : 'the account owning the key', type : 'string'}, {name : 'domain', description : 'the domain name of the key', type : 'string'}, {name : 'domainpath', description : 'the domain path of the key', 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 key', type : 'string'}, {name : 'enabled', description : 'whether the key is enabled', type : 'boolean'}, {name : 'keklabel', description : 'the provider-specific KEK label (admin only)', type : 'string'}], httprequesttype : 'POST'}, {name : 'changeSharedFileSystemDiskOffering', description : 'Change Disk offering of a Shared FileSystem', since : '4.20.0', isasync : True, related : '', params : [{name : 'miniops', description : 'min iops', type : 'long', length : 255, required : False}, {name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'changeSharedFileSystemDiskOffering'}, {name : 'size', description : 'the size of the shared filesystem in GiB', type : 'long', length : 255, required : False}, {name : 'maxiops', description : 'max iops', 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 : ''}], response : [{name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {}, {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 : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', 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 : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', 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 : '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 : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', 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 : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', 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 : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', 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 : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}]}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', 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 : 'domain', description : 'The domain associated with the tag', 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 : '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 : 'diskofferingid', description : 'disk offering ID for the shared filesystem', 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 shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', 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 : 'projectid', description : 'the project ID of 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 : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'volumename', description : 'name of the storage fs 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 : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}], httprequesttype : 'POST'}, {name : 'stopInstanceBootGroup', description : 'Stops all Instances in an Instance Boot Group in reverse order (highest boot order first). Continues through all tiers even if some Instances fail to stop', since : '24.0', isasync : True, related : '', params : [{name : 'forced', description : 'Force stop every Instance in the Instance Boot Group (marked as Stopped even when the stop command fails to be sent to the backend, otherwise a force poweroff is attempted)', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The ID of the Instance Boot Group', type : 'uuid', length : 255, required : True, related : 'stopInstanceBootGroup'}], response : [{}, {name : 'domain', description : 'The domain name of the instance boot group', type : 'string'}, {name : 'readinessattempttimeoutseconds', description : 'Effective timeout in seconds for each readiness retry attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'created', description : 'The date the instance boot group was created', type : 'date'}, {name : 'projectid', description : 'The project ID of the instance boot group', type : 'string'}, {name : 'accountid', description : 'The account ID owning the instance boot group', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'readinessrebootonretry', description : 'Effective setting for whether an instance is rebooted between readiness retry attempts (per-boot-group override if set, else the global default)', type : 'boolean'}, {name : 'id', description : 'The ID of the instance boot group', type : 'string'}, {name : 'domainpath', description : 'The path of the domain the instance boot group belongs to', type : 'string'}, {name : 'domainid', description : 'The domain ID of the instance boot group', type : 'string'}, {name : 'account', description : 'The account owning the instance boot group', type : 'string'}, {name : 'readinessmaxretryattempts', description : 'Effective maximum number of readiness retry attempts (per-boot-group override if set, else the global default)', type : 'long'}, {}, {name : 'readinessinitialdelayseconds', description : 'Effective delay in seconds after starting or rebooting an instance before its first readiness check of that attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'name', description : 'The name of the instance boot group', type : 'string'}, {name : 'project', description : 'The project name of the instance boot group', 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 instance boot group', 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 : '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 : 'getUploadParamsForTemplate', description : 'Upload an existing Template into the CloudStack cloud. ', since : '4.6.0', isasync : False, related : 'getUploadParamsForIso', params : [{name : 'displaytext', description : 'The display text of the Template. This is usually used for display purposes.', type : 'string', length : 4096, required : False}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', 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 : '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 : 'templatetag', description : 'The tag for this Template.', type : 'string', 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 : 'name', description : 'The name of the Volume/Template/ISO', type : 'string', length : 255, required : True}, {name : 'account', description : 'An optional accountName. Must be used with domainId.', type : 'string', 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 : 'ispublic', description : 'True if the Template is available to all accounts; default is true', 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 : 'requireshvm', description : 'True if this Template requires HVM', type : 'boolean', 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 : '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 : 'bits', description : '32 or 64 bits support. 64 by default', type : 'integer', length : 255, required : False}, {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 : 'sshkeyenabled', description : 'True if the Template supports the SSHkey upload feature; default is false', type : 'boolean', 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 : '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 : 'isextractable', description : 'True if the Template 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 : 'details', description : 'Template details in key/value pairs.', type : 'map', length : 255, required : False}, {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}], response : [{name : 'postURL', description : 'POST url to upload the file to', type : 'url'}, {name : 'signature', description : 'Signature to be sent in the POST request.', 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 : 'id', description : 'The Template/volume ID', type : 'uuid'}, {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'}, {}], httprequesttype : 'GET'}, {name : 'listAutoScaleVmProfiles', description : 'Lists autoscale Instance profiles.', isasync : False, related : '', params : [{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 : '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 : '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 : '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 : '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 : '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 : 'otherdeployparams', description : 'The otherdeployparameters of the autoscale Instance profile', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the autoscale Instance profile', type : 'uuid', length : 255, required : False, related : 'listAutoScaleVmProfiles'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {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'}], response : [{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 : 'id', description : 'The autoscale Instance profile ID', type : 'string'}, {name : 'autoscaleuserid', description : 'The ID of the User used to launch and destroy the Instances', type : 'string'}, {name : 'project', description : 'The project name of the Instance profile', type : 'string'}, {name : 'userdatapolicy', description : 'the userdata override policy with the userdata provided while deploying VM', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance profile', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', 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'}, {name : 'userdataname', description : 'the name of userdata used for the VM', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the vm profile belongs', type : 'string'}, {name : 'templateid', description : 'The Template to be used while deploying an Instance', type : 'string'}, {}, {name : 'userdata', description : 'Base64 encoded Instance user data', type : 'string'}, {}, {name : 'zoneid', description : 'The availability zone to be used while deploying an Instance', type : 'string'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer'}, {name : 'fordisplay', description : 'Is profile for display to the regular User', type : 'boolean'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance profile', type : 'string'}, {name : 'userdataid', description : 'the id of userdata used for the VM', type : 'string'}, {name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance', type : 'map'}], httprequesttype : 'GET'}, {name : 'updateBucket', description : 'Updates Bucket properties', since : '4.19.0', isasync : False, params : [{name : 'versioning', description : 'Enable/Disable Bucket Versioning', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The ID of the Bucket', type : 'uuid', length : 255, required : True, related : ''}, {name : 'quota', description : 'Bucket Quota in GiB', type : 'integer', length : 255, required : False}, {name : 'policy', description : 'Bucket Access Policy', type : 'string', length : 255, required : False}, {name : 'encryption', description : 'Enable/Disable Bucket encryption', type : 'boolean', length : 255, required : False}], 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 : '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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {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'}, {}], 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 : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', 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'}], response : [{}, {}, {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'}, {name : 'zonename', description : 'Tungsten-Fabric provider zone name', type : 'string'}, {name : 'uuid', description : 'Tungsten-Fabric nic uuid', type : 'string'}, {name : 'zoneid', description : 'Tungsten-Fabric provider zone id', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], 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 : '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 : 'secretkey', description : 'Secret key of the Webhook', type : 'string', length : 255, required : False}, {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 : ''}, {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 : 'sslverification', description : 'If set to true then SSL verification will be done for the Webhook otherwise not', type : 'boolean', length : 255, required : False}, {name : 'scope', description : 'Scope of the Webhook', type : 'string', length : 255, required : False}, {name : 'payloadurl', description : 'Payload URL of the Webhook', type : 'string', length : 255, required : True}], response : [{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 : 'domain', description : 'The name of the domain in which the Webhook exists', type : 'string'}, {name : 'secretkey', description : 'The secret key for the Webhook', type : 'string'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {name : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'account', description : 'The account associated with the Webhook', type : 'string'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}, {name : 'project', description : 'the project name of the Kubernetes cluster', type : 'string'}, {name : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', type : 'string'}, {}, {name : 'projectid', description : 'the project id of the Kubernetes cluster', 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'}], 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 : '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'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'startKubernetesCluster,updateKubernetesClusterAffinityGroups'}], response : [{name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', 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 : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zoneid', description : 'The name of the zone 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 : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for 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 : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'zonename', description : 'The name of the zone 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 : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names 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 : 'name', description : 'The name 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 : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {}, {name : 'serviceofferingid', description : 'The ID of the service offering 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 : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', 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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}], 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 : 'id', description : 'ID of the schedule to be deleted', type : 'uuid', length : 255, required : False, related : ''}, {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}], 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 : 'listKubernetesSupportedVersions', description : 'Lists supported Kubernetes version', isasync : False, related : 'getUploadParamsForKubernetesSupportedVersion', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the Kubernetes supported version', type : 'uuid', length : 255, required : False, related : 'getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions'}, {name : 'minimumkubernetesversionid', description : 'The ID of the minimum Kubernetes supported version', type : 'uuid', length : 255, required : False, related : 'getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions'}, {name : 'pagesize', description : '', type : 'integer', 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 : 'zonename', description : 'The name of the zone in which Kubernetes supported version is available', type : 'string'}, {name : 'zoneid', description : 'The ID of the zone in which Kubernetes supported version is available', type : 'string'}, {name : 'isoid', description : 'The ID of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'isourl', description : 'the URL of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'mincpunumber', description : 'The minimum number of CPUs needed for the Kubernetes supported version', type : 'integer'}, {name : 'supportsautoscaling', description : 'Whether Kubernetes supported version supports Autoscaling', type : 'boolean'}, {name : 'name', description : 'Name of the Kubernetes supported version', type : 'string'}, {name : 'supportsha', description : 'Whether Kubernetes supported version supports HA, multi-control nodes', type : 'boolean'}, {name : 'minmemory', description : 'The minimum RAM size in MB needed for the Kubernetes supported version', type : 'integer'}, {}, {name : 'id', description : 'The ID of the Kubernetes supported version', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes supported version was created', type : 'date'}, {}, {name : 'isoname', description : 'The name of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'isostate', description : 'The state of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'state', description : 'The enabled or disabled state of the Kubernetes supported version', type : 'string'}, {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 : 'semanticversion', description : 'Kubernetes semantic version', type : 'string'}, {name : 'arch', description : 'the arch 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'}], httprequesttype : 'GET'}, {name : 'checkVmwareCbtMigrationPrerequisites', description : 'Check whether a VMware VM and KVM destination are ready for VMware CBT based migration', since : '4.24.0', isasync : False, related : '', params : [{name : 'clustername', description : 'the source VMware cluster name', type : 'string', length : 255, required : False}, {name : 'details', description : 'optional service offering custom parameters and migration details', type : 'map', length : 255, required : False}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'uuid', length : 255, required : True, related : 'addCluster'}, {name : 'vcenter', description : 'the source vCenter IP address or FQDN', type : 'string', length : 255, required : False}, {name : 'convertinstancepoolid', description : 'optional primary storage pool for converted disks', type : 'uuid', length : 255, required : False, related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance'}, {name : 'convertinstancehostid', description : 'optional KVM host to perform CBT block replication', type : 'uuid', length : 255, required : False, related : 'reconnectHost'}, {name : 'datacentername', description : 'the source VMware datacenter name', type : 'string', length : 255, required : False}, {name : 'hostip', description : 'the source VMware ESXi host IP address or FQDN', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'the destination zone ID', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string', length : 255, required : True}, {name : 'existingvcenterid', description : 'UUID of a linked existing vCenter', type : 'uuid', length : 255, required : False, related : ''}, {name : 'serviceofferingid', description : 'optional service offering to validate against the source VM CPU and memory requirements', type : 'uuid', length : 255, required : False, related : 'updateServiceOffering,listServiceOfferings'}, {name : 'username', description : 'the username for the source vCenter', type : 'string', length : 255, required : False}, {name : 'password', description : 'the password for the source vCenter', type : 'string', length : 255, required : False}], response : [{name : 'storagewritertype', description : 'the VMware CBT target storage writer type', type : 'string'}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'string'}, {name : 'sourcecpunumber', description : 'source VMware VM CPU count', type : 'integer'}, {name : 'convertinstancepoolid', description : 'the destination storage pool ID', type : 'string'}, {name : 'sourcecpuspeed', description : 'source VMware VM CPU reservation in MHz used for offering validation, when available', type : 'integer'}, {name : 'convertinstancehostid', description : 'the KVM host selected for conversion and CBT replication', type : 'string'}, {name : 'sourceguestos', description : 'source VMware VM guest OS name', type : 'string'}, {name : 'zonename', description : 'the destination zone name', type : 'string'}, {name : 'sourcememory', description : 'source VMware VM memory in MB', type : 'integer'}, {name : 'ready', description : 'whether the source VM and destination are ready for VMware CBT migration start', type : 'boolean'}, {name : 'convertinstancehostinplacefinalizationsupported', description : 'whether the selected KVM host reports VMware CBT in-place finalization support', type : 'boolean'}, {name : 'datacentername', description : 'the source VMware datacenter', type : 'string'}, {name : 'storagerequiresinplacefinalization', description : 'whether the target storage writer requires virt-v2v in-place finalization', type : 'boolean'}, {name : 'existingsnapshotcount', description : 'number of existing VMware snapshots on the source VM', type : 'integer'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'storagepooltype', description : 'the destination storage pool type', type : 'string'}, {name : 'sourcevmmor', description : 'the source VMware VM managed object reference', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'poolname', description : 'the destination storage pool name', type : 'string'}, {name : 'finding', description : 'preflight findings', type : 'list'}, {name : 'changetrackingsupported', description : 'whether the source VM reports CBT support', type : 'boolean'}, {name : 'disk', description : 'source VMware disk preflight information', type : 'list'}, {}, {name : 'convertinstancehostname', description : 'the KVM host selected for conversion and CBT replication', type : 'string'}, {name : 'sourcehost', description : 'the source VMware ESXi host', type : 'string'}, {name : 'sourceguestosid', description : 'source VMware VM guest OS identifier', type : 'string'}, {name : 'clustername', description : 'the destination KVM cluster name', type : 'string'}, {name : 'storagewritersupported', description : 'whether the target storage writer is implemented', type : 'boolean'}, {name : 'vcenter', description : 'the source VMware vCenter', type : 'string'}, {name : 'noninplacefinalizationfallbacksupported', description : 'whether the selected target storage can use non-in-place fallback finalization', type : 'boolean'}, {name : 'noninplacefinalizationfallbackallowed', description : 'whether VMware CBT non-in-place fallback finalization is enabled by configuration', type : 'boolean'}, {name : 'consolidationneeded', description : 'whether the source VM reports disk consolidation is needed', type : 'boolean'}, {name : 'changetrackingenabled', description : 'whether CBT is currently enabled on the source VM', type : 'boolean'}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string'}, {name : 'zoneid', description : 'the destination zone ID', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'cutoverVmwareCbtMigration', description : 'Perform final cutover for a VMware CBT migration', since : '4.24.0', isasync : True, related : 'listVmwareCbtMigrations,cancelVmwareCbtMigration', params : [{name : 'password', description : 'optional password override for the source vCenter. Stored external vCenter credentials are used when available', type : 'string', length : 255, required : False}, {name : 'id', description : 'the VMware CBT migration ID', type : 'uuid', length : 255, required : True, related : 'listVmwareCbtMigrations,cutoverVmwareCbtMigration,cancelVmwareCbtMigration'}, {name : 'username', description : 'optional username override for the source vCenter. Stored external vCenter credentials are used when available', type : 'string', length : 255, required : False}], response : [{name : 'datacentername', description : 'the source VMware datacenter', type : 'string'}, {name : 'accountid', description : 'the account ID', type : 'string'}, {name : 'zoneid', description : 'the destination zone ID', type : 'string'}, {name : 'displayname', description : 'the display name of the target VM', type : 'string'}, {name : 'clustername', description : 'the destination KVM cluster name', type : 'string'}, {name : 'quietcycles', description : 'the number of consecutive quiet CBT delta cycles', type : 'int'}, {name : 'disk', description : 'the source and target disks tracked by this VMware CBT migration', type : 'list'}, {name : 'currentstepduration', description : 'the elapsed time spent in the current migration step', type : 'string'}, {name : 'lastchangedbytes', description : 'the changed bytes observed in the last CBT delta cycle', type : 'long'}, {name : 'state', description : 'the migration state', type : 'string'}, {name : 'cycle', description : 'the CBT delta synchronization cycles tracked by this VMware CBT migration', type : 'list'}, {name : 'currentstep', description : 'the current migration step', type : 'string'}, {name : 'lastdirtyrate', description : 'the dirty rate in bytes per second observed in the last CBT delta cycle', type : 'long'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'convertinstancehostname', description : 'the KVM host name selected for conversion and CBT replication', type : 'string'}, {name : 'totalchangedbytes', description : 'the total changed bytes synchronized across CBT delta cycles', type : 'long'}, {name : 'convertinstancehostid', description : 'the KVM host selected for conversion and CBT replication', type : 'string'}, {name : 'convertinstancepoolid', description : 'the storage pool selected for converted disks', type : 'string'}, {name : 'poolname', description : 'the storage pool name selected for converted disks', type : 'string'}, {name : 'sourcehost', description : 'the source VMware ESXi host', type : 'string'}, {name : 'zonename', description : 'the destination zone name', type : 'string'}, {name : 'id', description : 'the ID of the VMware CBT migration', type : 'string'}, {name : 'vcenter', description : 'the source VMware vCenter', type : 'string'}, {name : 'virtualmachineid', description : 'the ID of the imported VM after cutover', type : 'string'}, {name : 'created', description : 'the create date of the VMware CBT migration', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'string'}, {name : 'completedcycles', description : 'the number of completed CBT delta cycles', type : 'int'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'sourcecluster', description : 'the source VMware cluster', type : 'string'}, {}, {name : 'lasterror', description : 'the last migration error', type : 'string'}, {name : 'lastupdated', description : 'the last updated date of the VMware CBT migration', type : 'date'}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string'}, {name : 'existingvcenterid', description : 'the linked existing vCenter ID, when used', type : 'string'}, {}], httprequesttype : 'POST'}, {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 : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', 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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {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', type : 'set', response : [{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 : '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 : 'account', description : 'The Account 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 : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {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 : '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 Instance', type : 'long'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'vmstate', description : 'State of 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 : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}], httprequesttype : 'POST'}, {name : 'cancelVmwareCbtMigration', description : 'Cancel a VMware CBT migration session', since : '4.24.0', isasync : False, related : 'listVmwareCbtMigrations', params : [{name : 'id', description : 'the VMware CBT migration ID', type : 'uuid', length : 255, required : True, related : 'listVmwareCbtMigrations,cancelVmwareCbtMigration'}], response : [{name : 'displayname', description : 'the display name of the target VM', type : 'string'}, {name : 'poolname', description : 'the storage pool name selected for converted disks', type : 'string'}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string'}, {name : 'lasterror', description : 'the last migration error', type : 'string'}, {name : 'currentstepduration', description : 'the elapsed time spent in the current migration step', type : 'string'}, {name : 'vcenter', description : 'the source VMware vCenter', type : 'string'}, {name : 'convertinstancehostname', description : 'the KVM host name selected for conversion and CBT replication', type : 'string'}, {}, {name : 'created', description : 'the create date of the VMware CBT migration', type : 'date'}, {name : 'accountid', description : 'the account ID', type : 'string'}, {name : 'currentstep', description : 'the current migration step', type : 'string'}, {name : 'sourcecluster', description : 'the source VMware cluster', type : 'string'}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'string'}, {name : 'datacentername', description : 'the source VMware datacenter', type : 'string'}, {name : 'disk', description : 'the source and target disks tracked by this VMware CBT migration', type : 'list'}, {name : 'existingvcenterid', description : 'the linked existing vCenter ID, when used', type : 'string'}, {name : 'zoneid', description : 'the destination zone ID', type : 'string'}, {name : 'quietcycles', description : 'the number of consecutive quiet CBT delta cycles', type : 'int'}, {name : 'totalchangedbytes', description : 'the total changed bytes synchronized across CBT delta cycles', type : 'long'}, {name : 'cycle', description : 'the CBT delta synchronization cycles tracked by this VMware CBT migration', type : 'list'}, {}, {name : 'sourcehost', description : 'the source VMware ESXi host', type : 'string'}, {name : 'completedcycles', description : 'the number of completed CBT delta cycles', type : 'int'}, {name : 'virtualmachineid', description : 'the ID of the imported VM after cutover', type : 'string'}, {name : 'lastupdated', description : 'the last updated date of the VMware CBT migration', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'lastdirtyrate', description : 'the dirty rate in bytes per second observed in the last CBT delta cycle', type : 'long'}, {name : 'convertinstancehostid', description : 'the KVM host selected for conversion and CBT replication', type : 'string'}, {name : 'id', description : 'the ID of the VMware CBT migration', type : 'string'}, {name : 'convertinstancepoolid', description : 'the storage pool selected for converted disks', type : 'string'}, {name : 'clustername', description : 'the destination KVM cluster name', type : 'string'}, {name : 'state', description : 'the migration state', type : 'string'}, {name : 'zonename', description : 'the destination zone name', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'lastchangedbytes', description : 'the changed bytes observed in the last CBT delta cycle', type : 'long'}, {name : 'account', description : 'the account name', 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 : '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 : '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 : '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 : 'backupofferingid', description : 'List by the backup offering', type : 'uuid', length : 255, required : False, since : '4.17', related : ''}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {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 : 'securitygroupid', description : 'The security group ID', type : 'uuid', length : 255, required : False, since : '4.15', related : ''}, {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 : 'vpcid', description : 'List Instances by VPC', type : 'uuid', length : 255, required : False, related : 'createVPC,listVPCs,updateVPC'}, {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 : 'keypair', description : 'List Instances by SSH keypair name', type : 'string', length : 255, required : False}, {name : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,updateNetwork,listNetworks'}, {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 : '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 : 'page', 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 : ''}, {name : 'userdataid', description : 'the instances by userdata', type : 'uuid', length : 255, required : False, since : '4.20.1', related : ''}, {name : 'leased', description : 'Whether to return only leased instances', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string', length : 255, required : False, since : '4.20.1'}, {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 : 'autoscalevmgroupid', description : 'The ID of AutoScaling Instance Group', type : 'uuid', length : 255, required : False, since : '4.18.0', related : ''}, {name : 'hypervisor', description : 'The target hypervisor for the Template', type : 'string', length : 255, required : False}, {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 : '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 : '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 : 'extensionid', description : 'The ID of the Orchestrator extension for the VM', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listExtensions'}, {name : 'serviceofferingid', description : 'List by the service offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'updateServiceOffering,listServiceOfferings'}, {name : 'affinitygroupid', description : 'List Instances by affinity group', type : 'uuid', length : 255, required : False, related : ''}, {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 : '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 : 'showicon', description : 'Flag to display the resource icon for Instances', type : 'boolean', length : 255, required : False, since : '4.16.0.0'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', 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 : 'isoid', description : 'List Instances by ISO', type : 'uuid', 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 : 'zoneid', description : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'groupid', description : 'The group ID', type : 'uuid', length : 255, required : False, related : ''}], response : [{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 : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {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 : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {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 : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{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 : 'projectid', description : 'The project ID the tag belongs to', 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 : 'domainpath', description : 'Path of the Domain 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 : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}]}, {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 : '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 : '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 : 'account', description : 'Account owning 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 : '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 : 'project', description : 'The project name of the 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 : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'name', description : 'The name of the security 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 : '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 : '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 : 'ruleid', description : 'The ID 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 : '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 : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', 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 : '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 : '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 : 'description', description : 'The description of the security group', 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 : '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 : '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 : 'projectid', description : 'The project ID the 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 : '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 : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}]}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', 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 : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', 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 : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', 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 : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {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 : '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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', 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 : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'traffictype', description : 'The traffic type of the NIC', 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 : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}]}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', 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 : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'templatename', description : 'The name of the Template for 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 : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {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 : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'name', description : 'The name 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 : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", 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 : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", 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 : '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 : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {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', 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 : 'value', description : 'Tag value', 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 : 'customer', description : 'Customer 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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read 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 : '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 : '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 : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {}, {name : 'userdataname', description : 'The name of userdata used for 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 : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'state', description : 'The state of 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 : '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 : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', 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 : '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 : 'hypervisor', description : 'The hypervisor on which the Template runs', 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 : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'name', description : 'The 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 : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', 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 : 'dedicatedresources', description : 'dedicated resources 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 Instance', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateInstanceBootGroupReadinessRule', description : 'Updates an Instance Boot Group readiness rule. The rule type, Instance Boot Group and item are immutable after creation.', since : '24.0', isasync : False, related : '', params : [{name : 'enabled', description : 'Whether the rule is enabled', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'New name for the readiness rule', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the readiness rule', type : 'uuid', length : 255, required : True, related : 'updateInstanceBootGroupReadinessRule'}, {name : 'details', description : 'Rule-type-specific configuration', type : 'map', length : 255, required : False}], response : [{name : 'enabled', description : 'Whether the rule is enabled', type : 'boolean'}, {name : 'checkedon', description : 'When this rule was last evaluated', type : 'date'}, {name : 'id', description : 'The ID of the readiness rule', type : 'string'}, {}, {name : 'memberid', description : 'The ID of the item (VM or instance group) this rule applies to', type : 'string'}, {name : 'readinessstatus', description : 'The last cached evaluation status of this rule: READY, NOT_READY, ERROR or UNKNOWN', type : 'string'}, {}, {name : 'created', description : 'The date the rule was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'The name of the readiness rule', type : 'string'}, {name : 'statusmessage', description : 'The message from the last evaluation of this rule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'ruletype', description : 'The readiness rule type', type : 'string'}, {name : 'details', description : 'Rule-type-specific configuration', type : 'map'}, {name : 'membertype', description : 'The item type this rule applies to: VirtualMachine or InstanceGroup', type : 'string'}, {name : 'membername', description : 'The name of the item (VM or instance group) this rule applies to', type : 'string'}, {name : 'bootgroupid', description : 'The ID of the boot group this rule belongs to', type : 'string'}, {name : 'inherited', description : "True if this rule is not attached to the queried item directly, but inherited from its owning InstanceGroup (only possible when listing by virtualmachineid; the rule's itemtype/itemid still refer to the InstanceGroup it's actually attached to)", type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listSystemVmsUsageHistory', description : 'Lists System VM stats', since : '4.18.0', isasync : False, related : '', params : [{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 : 'pagesize', description : '', type : 'integer', 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 : 'page', description : '', type : 'integer', 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 : 'enddate', description : 'End date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', 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}], response : [{name : 'stats', description : 'The list of Instance stats', type : 'list', response : [{name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'memoryintfreekbs', description : "The Instance's free memory in KB or -1 if it cannot be gathered", type : 'long'}, {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 : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'networkread', description : 'The amount of downloaded data by the Instance in MiB', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KB)', type : 'long'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {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 : 'cpuused', description : "The amount (percentage) of the Instance's CPU currently used", type : 'string'}, {name : 'networkwrite', description : 'The amount of uploaded data by the Instance in MiB', type : 'string'}, {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 : '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 : '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 : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'name', description : 'The Name of the Instance', type : 'string'}, {}, {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 : '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 : 'listVMSnapshot', description : 'List Instance Snapshot by conditions', since : '4.2.0', isasync : False, related : 'createVMSnapshot', params : [{name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'name', description : 'Lists Snapshot by Snapshot name or display name', type : 'string', length : 255, required : False}, {name : 'state', description : 'State of the Instance Snapshot', type : 'string', 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 : 'vmsnapshotid', description : 'The ID of the Instance Snapshot', type : 'uuid', length : 255, required : False, 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 : '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 : '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 : '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 : '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 : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{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 : 'current', description : 'Indicates if this is current Snapshot', type : 'boolean'}, {name : 'parent', description : 'The parent ID of the Instance Snapshot', type : 'string'}, {name : 'projectid', description : 'The project ID of the VPN', type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID of the Instance Snapshot', type : 'string'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {}, {name : 'description', description : 'The description of the Instance Snapshot', 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 Snapshot', type : 'string'}, {}, {name : 'parentName', description : 'The parent displayName of the Instance Snapshot', type : 'string'}, {name : 'hypervisor', description : 'The type of hypervisor on which Snapshot is stored', type : 'string'}, {name : 'state', description : 'The state of the Instance Snapshot', type : 'state'}, {name : 'zonename', description : 'The Zone name of the Instance Snapshot', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displayname', description : 'The display name of the Instance Snapshot', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name of the Instance Snapshot', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'zoneid', description : 'The Zone ID 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 : '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 : 'domainpath', description : 'Path of 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 : '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 : 'type', description : 'Instance Snapshot type', type : 'string'}, {name : 'created', description : 'The create date of the Instance Snapshot', type : 'date'}, {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 : 'id', description : 'The UUID of the KMS key to update', type : 'uuid', length : 255, required : True, related : 'updateKMSKey'}, {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}], response : [{}, {name : 'id', description : 'the UUID of the key', type : 'string'}, {name : 'zoneid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'enabled', description : 'whether the key is enabled', type : 'boolean'}, {name : 'description', description : 'the description of the key', type : 'string'}, {name : 'projectid', description : 'the project ID of the key', type : 'string'}, {name : 'name', description : 'the name of the key', type : 'string'}, {name : 'account', description : 'the account owning the key', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'keklabel', description : 'the provider-specific KEK label (admin only)', type : 'string'}, {name : 'hsmprofileid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'hsmprofile', description : 'the zone name where the key is valid', type : 'string'}, {}, {name : 'domain', description : 'the domain name of the key', type : 'string'}, {name : 'algorithm', description : 'the encryption algorithm', type : 'string'}, {name : 'domainid', description : 'the domain ID of the key', type : 'string'}, {name : 'keybits', description : 'the key size in bits', type : 'integer'}, {name : 'project', description : 'the project name of the key', type : 'string'}, {name : 'accountid', description : 'the account ID owning the key', type : 'string'}, {name : 'created', description : 'the creation timestamp', type : 'date'}, {name : 'zonename', description : 'the zone name where the key is valid', type : 'string'}, {name : 'version', description : 'the key size in bits', type : 'integer'}, {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'}], 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 : 'related', description : 'Comma separated related apis', 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'}, {name : 'name', description : 'The name of the API command', type : 'string'}, {name : 'params', description : 'The list params the api accepts', type : 'set', response : [{name : 'related', description : 'Comma separated related APIs to get the parameter', type : 'string'}, {name : 'type', description : 'Parameter type', type : 'string'}, {name : 'since', description : 'Version of CloudStack the API was introduced in', type : 'string'}, {name : 'description', description : 'Description of the API parameter', type : 'string'}, {}, {name : 'required', description : 'True if this parameter is required for the API request', type : 'boolean'}, {name : 'length', description : 'Length of the parameter', type : 'int'}, {name : 'name', description : 'The name of the API parameter', type : 'string'}]}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'description', description : 'Description of the API', type : 'string'}, {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 : 'response', description : 'API response fields', type : 'set', response : [{name : 'description', description : 'Description of the API response field', type : 'string'}, {name : 'name', description : 'The name of the API response field', type : 'string'}, {name : 'response', description : 'API response fields', type : 'set'}, {name : 'type', description : 'Response field type', type : 'string'}]}], httprequesttype : 'GET'}, {name : 'createVMSnapshot', description : 'Creates Snapshot for an Instance. Running KVM UEFI disk-only snapshots briefly suspend the Instance while copying NVRAM state.', since : '4.2.0', isasync : True, related : '', params : [{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 : 'quiescevm', description : 'Quiesce Instance if true', type : 'boolean', length : 255, required : False}, {name : 'snapshotmemory', description : 'Snapshot memory if true', type : 'boolean', length : 255, required : False}, {name : 'description', description : 'The description of the Snapshot', type : 'string', length : 255, required : False}, {name : 'name', description : 'The display name of the Snapshot', type : 'string', length : 255, required : False}], response : [{name : 'description', description : 'The description of the Instance Snapshot', type : 'string'}, {name : 'created', description : 'The create date of the Instance Snapshot', type : 'date'}, {}, {name : 'state', description : 'The state of the Instance Snapshot', type : 'state'}, {name : 'virtualmachinename', description : 'The Instance name of the Instance Snapshot', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'current', description : 'Indicates if this is current Snapshot', type : 'boolean'}, {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 VPN', type : 'string'}, {name : 'parentName', description : 'The parent displayName of the Instance Snapshot', type : 'string'}, {name : 'hypervisor', description : 'The type of hypervisor on which Snapshot is stored', type : 'string'}, {name : 'id', description : 'The ID of the Instance Snapshot', type : 'string'}, {name : 'type', description : 'Instance Snapshot type', type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID of the Instance Snapshot', type : 'string'}, {name : 'parent', description : 'The parent ID of the Instance Snapshot', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the disk volume belongs', type : 'string'}, {name : 'zoneid', description : 'The Zone ID of the Instance Snapshot', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'displayname', description : 'The display name of the Instance Snapshot', type : 'string'}, {name : 'projectid', description : 'The project ID of the VPN', 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 : '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 : 'projectid', description : 'The project ID the tag belongs to', 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 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 : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'zonename', description : 'The Zone name of the Instance Snapshot', type : 'string'}], httprequesttype : 'POST'}, {name : 'listVmwareCbtMigrations', description : 'List VMware CBT based migration sessions', since : '4.24.0', isasync : False, related : '', params : [{name : 'zoneid', description : 'the destination zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'accountid', description : 'the account ID', type : 'uuid', length : 255, required : False, related : 'enableAccount,listAccounts'}, {name : 'id', description : 'the VMware CBT migration ID', type : 'uuid', length : 255, required : False, related : 'listVmwareCbtMigrations'}, {name : 'state', description : 'the migration state', type : 'string', length : 255, required : False}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string', length : 255, required : False}, {name : 'vcenter', description : 'the source VMware vCenter', 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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'convertinstancepoolid', description : 'the storage pool selected for converted disks', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zonename', description : 'the destination zone name', type : 'string'}, {name : 'poolname', description : 'the storage pool name selected for converted disks', type : 'string'}, {name : 'id', description : 'the ID of the VMware CBT migration', type : 'string'}, {name : 'zoneid', description : 'the destination zone ID', type : 'string'}, {name : 'virtualmachineid', description : 'the ID of the imported VM after cutover', type : 'string'}, {name : 'existingvcenterid', description : 'the linked existing vCenter ID, when used', type : 'string'}, {name : 'disk', description : 'the source and target disks tracked by this VMware CBT migration', type : 'list'}, {name : 'clustername', description : 'the destination KVM cluster name', type : 'string'}, {name : 'convertinstancehostname', description : 'the KVM host name selected for conversion and CBT replication', type : 'string'}, {name : 'vcenter', description : 'the source VMware vCenter', type : 'string'}, {name : 'sourcecluster', description : 'the source VMware cluster', type : 'string'}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string'}, {}, {name : 'created', description : 'the create date of the VMware CBT migration', type : 'date'}, {name : 'lastdirtyrate', description : 'the dirty rate in bytes per second observed in the last CBT delta cycle', type : 'long'}, {name : 'accountid', description : 'the account ID', type : 'string'}, {name : 'cycle', description : 'the CBT delta synchronization cycles tracked by this VMware CBT migration', type : 'list'}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'string'}, {name : 'totalchangedbytes', description : 'the total changed bytes synchronized across CBT delta cycles', type : 'long'}, {name : 'state', description : 'the migration state', type : 'string'}, {name : 'currentstep', description : 'the current migration step', type : 'string'}, {name : 'displayname', description : 'the display name of the target VM', type : 'string'}, {name : 'lasterror', description : 'the last migration error', type : 'string'}, {}, {name : 'lastchangedbytes', description : 'the changed bytes observed in the last CBT delta cycle', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'convertinstancehostid', description : 'the KVM host selected for conversion and CBT replication', type : 'string'}, {name : 'datacentername', description : 'the source VMware datacenter', type : 'string'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'lastupdated', description : 'the last updated date of the VMware CBT migration', type : 'date'}, {name : 'quietcycles', description : 'the number of consecutive quiet CBT delta cycles', type : 'int'}, {name : 'completedcycles', description : 'the number of completed CBT delta cycles', type : 'int'}, {name : 'sourcehost', description : 'the source VMware ESXi host', type : 'string'}, {name : 'currentstepduration', description : 'the elapsed time spent in the current migration step', type : 'string'}], httprequesttype : 'GET'}, {name : 'getUploadParamsForIso', description : 'Upload an existing ISO into the CloudStack cloud.', since : '4.13', isasync : False, related : '', params : [{name : 'displaytext', description : 'The display text of the ISO. This is usually used for display purposes.', type : 'string', length : 4096, 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 : 'isextractable', description : 'True if the ISO or its derivatives are extractable; default is false', 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 : 'account', description : 'An optional accountName. Must be used with domainId.', 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 : 'projectid', description : 'Upload Volume/Template/ISO for the project', type : 'uuid', length : 255, required : False, related : ''}, {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}, {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 : '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 : '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 : 'name', description : 'The name of the Volume/Template/ISO', type : 'string', length : 255, required : True}, {name : 'isfeatured', description : 'True if you want this ISO to be featured', type : 'boolean', length : 255, required : False}], response : [{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 : '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 : 'postURL', description : 'POST url to upload the file to', type : 'url'}, {}, {name : 'metadata', description : 'Encrypted data to be sent in the POST request.', type : 'string'}, {name : 'id', description : 'The Template/volume ID', type : 'uuid'}], 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 : '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 : 'listUserKeys', description : 'Lists the API key pairs (API and secret keys) of a user.', since : '4.23.0', isasync : False, related : '', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'apikeyfilter', description : 'API key of the key pair.', type : 'string', length : 255, required : False}, {name : 'showpermissions', description : 'Whether API Key rules should be returned. Defaults to false.', type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'userid', description : 'ID of the user that owns the keys.', type : 'uuid', length : 255, required : False, related : 'getUser'}, {name : 'page', description : '', type : 'integer', 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 : 'keypairid', description : 'ID of the key pair.', type : 'uuid', length : 255, required : False, related : 'listUserKeys'}], response : [{name : 'id', description : 'ID of the API key pair.', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'startdate', description : 'API key pair start date.', type : 'date'}, {name : 'domainpath', description : 'Path of the domain which the account belongs to.', type : 'string'}, {name : 'roleid', description : 'ID of the role.', type : 'string'}, {name : 'permissions', description : 'Permissions of the API key pair.', type : 'list'}, {name : 'username', description : "Username of the keypair's owner.", type : 'string'}, {}, {name : 'domain', description : 'Name of the domain which the account belongs to.', type : 'string'}, {}, {name : 'name', description : 'Name of the API key pair', type : 'string'}, {name : 'enddate', description : 'API key pair expiration date.', type : 'date'}, {name : 'userid', description : 'ID of the user that owns the keypair.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'created', description : 'API key pair creation timestamp.', type : 'date'}, {name : 'state', description : 'State of the API key pair.', type : 'apikeypairstate'}, {name : 'accounttype', description : 'Account type.', type : 'string'}, {name : 'rolename', description : 'Name of the role.', type : 'string'}, {name : 'domainid', description : 'ID of the domain which the account belongs to.', type : 'string'}, {name : 'accountid', description : 'Account ID.', type : 'string'}, {name : 'secretkey', description : 'The secret key of the registered user.', type : 'string'}, {name : 'description', description : 'API key pair description.', type : 'string'}, {name : 'accountname', description : 'Account name.', type : 'string'}, {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 : 'roletype', description : 'Type of the role (Admin, ResourceAdmin, DomainAdmin, User).', type : 'string'}], 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 : '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 : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', 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 : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', 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 : '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 : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {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 : '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 : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'zoneid', description : 'The name of the zone 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 : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'kubernetesversionid', description : 'The ID 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 : '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 : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', 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 : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on 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 : 'memory', description : 'The memory 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 : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {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 : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'account', description : 'The Account associated with 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 : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}], httprequesttype : 'POST'}, {name : 'listSharedFileSystemProviders', description : 'Lists all available shared filesystem providers.', since : '4.20.0', isasync : False, related : '', params : [{name : 'pagesize', description : '', type : 'integer', 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}], response : [{}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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'}, {}], httprequesttype : 'GET'}, {name : 'listBackupSchedule', description : 'List backup schedule of an Instance', since : '4.14.0', isasync : False, related : '', params : [{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 : 'id', description : 'the ID of the backup schedule', type : 'uuid', length : 255, required : False, since : '4.22.0', related : 'listBackupSchedule'}, {name : 'pagesize', 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 : 'listDomains'}, {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 : '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 : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {name : 'maxbackups', description : 'maximum number of backups retained', type : 'integer'}, {name : 'id', description : 'ID of the backup schedule.', type : 'string'}, {}, {name : 'schedule', description : 'The time the backup is scheduled to be taken.', type : 'string'}, {}, {name : 'quiescevm', description : 'quiesce the instance before checkpointing the disks for backup', type : 'boolean'}, {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 : 'intervaltype', description : 'The interval type of the backup schedule', type : 'intervaltype'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'timezone', description : 'The time zone of the backup schedule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'restoreVolumeFromBackupAndAttachToVM', description : 'Restore and attach a backed up volume to Instance', since : '4.14.0', isasync : True, params : [{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'}, {name : 'volumeid', description : 'ID of the volume backed up', type : 'string', length : 255, required : True}, {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 : ''}], 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 : 'removeNetworkPermissions', description : 'Removes Network permissions.', since : '4.17.0', isasync : False, params : [{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 : 'networkid', description : 'The Network ID', type : 'uuid', length : 255, required : True, related : 'createNetwork,updateNetwork,listNetworks'}, {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 : '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 : '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 : '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 : 'deleteProjectRolePermission', description : 'Deletes a project role permission in the project', since : '4.15.0', isasync : False, params : [{name : 'id', description : 'ID of the project role permission to be deleted', type : 'uuid', length : 255, required : True, related : ''}, {name : 'projectid', description : 'ID of the project where the project role permission is to be deleted', type : 'uuid', length : 255, required : True, related : ''}], 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 : '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 : 'passwordenabled', description : 'True if the image supports the password reset feature; default is false', type : 'boolean', 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 : 'cleanupvnfnics', description : 'optional boolean field, which indicates if VNF nics will be cleaned up or not', type : 'boolean', length : 255, required : False}, {name : 'format', description : 'The format for the image', type : 'string', length : 255, required : False}, {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 : 'cleanupvnfdetails', description : 'optional boolean field, which indicates if VNF details will be cleaned up or not', type : 'boolean', length : 255, required : False}, {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 : '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 : 'sortkey', description : 'Sort key of the Template, integer', type : 'integer', length : 255, required : False}, {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 : '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 : 'ostypeid', description : 'The ID of the OS type that best represents the OS of this image.', type : 'uuid', length : 255, required : False, related : ''}, {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 : 'templatetag', description : 'the tag for this template.', type : 'string', length : 255, required : False, since : '4.20.0'}, {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 : '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 : '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 : 'displaytext', description : 'The display text of the image', type : 'string', length : 4096, 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 : '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 : 'bootable', description : 'True if image is bootable, false otherwise; available only for updateIso API', 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'}], response : [{name : 'templatetype', description : 'The type of the Template', type : 'string'}, {name : 'isextractable', description : 'True if the Template is extractable, false otherwise', type : 'boolean'}, {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 : 'extensionid', description : 'The ID of extension linked to this template', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', type : 'string'}, {name : 'extensionname', description : 'The name of extension linked to this template', type : 'string'}, {name : 'hostname', description : 'The name 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 : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {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 : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'sourcetemplateid', description : 'The Template ID of the parent Template if present', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'templatetag', description : 'The tag of this Template', type : 'string'}, {name : 'sshkeyenabled', description : 'True if Template is sshkey enabled, false otherwise', type : 'boolean'}, {name : 'name', description : 'The Template name', type : 'string'}, {name : 'account', description : 'The Account name to which the Template belongs', type : 'string'}, {name : 'userdataname', description : 'The name of userdata linked to this Template', type : 'string'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'url', description : 'The URL which the Template/ISO is registered from', type : 'string'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}, {name : 'domain', description : 'The name of the domain to which the Template belongs', type : 'string'}, {name : 'userdataid', description : 'The id of userdata linked to this Template', type : 'string'}, {name : 'hostid', description : 'The ID of the secondary storage host for the Template', type : 'string'}, {}, {name : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'id', description : 'The Template ID', type : 'string'}, {name : 'format', description : 'The format of the Template.', type : 'imageformat'}, {name : 'displaytext', description : 'The Template display text', type : 'string'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {name : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {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 : 'bits', description : 'The processor bit size', type : 'int'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'status', description : 'The status of the Template', 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 : '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 : '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 : '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 : 'size', description : 'The size of the Template', type : 'long'}, {name : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {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 : 'zonename', description : 'The name of the zone for this Template', type : 'string'}, {name : 'isready', description : 'True if the Template is ready to be deployed from, false otherwise.', type : 'boolean'}, {name : 'ostypeid', description : 'The ID of the OS type 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 : 'ispublic', description : 'True if this Template is a public Template, false otherwise', type : 'boolean'}, {name : 'removed', description : 'The date this Template was removed', type : 'date'}, {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 : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'project', description : 'The project name of the Template', type : 'string'}, {name : 'arch', description : 'CPU Arch of the 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 : 'name', description : 'The user two factor authenticator provider name', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'description', description : 'The description of the user two factor authenticator provider', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], 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 : 'name', description : 'The name of the Instance as it is known to the hypervisor', type : 'string', length : 255, required : True}, {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 : 'displayname', description : 'The display name of the Instance', type : 'string', length : 255, required : False}, {name : 'networkid', description : 'the network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,updateNetwork,listNetworks'}, {name : 'hostname', description : 'The host name of the Instance', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'Import Instance to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'nicipaddresslist', description : 'VM NIC to ip address mapping using keys NIC, ip4Address', type : 'map', length : 255, required : False}, {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 : 'clusterid', description : 'The cluster ID', type : 'uuid', length : 255, required : True, related : ''}, {name : 'importsource', description : 'Source location for Import', type : 'string', length : 255, required : True}, {name : 'datacentername', description : '(only for importing VMs from VMware to KVM) Name of VMware datacenter.', type : 'string', length : 255, required : False}, {name : 'details', description : 'Used to specify the custom parameters.', type : 'map', 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 : '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 : '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 : 'vmwaremigrationmode', description : '(only for importing VMs from VMware to KVM) optional - migration mode to use. Valid values are OVF, VDDK, and CBT. When omitted, CloudStack preserves the existing usevddk behavior.', type : 'string', length : 255, required : False, since : '4.22.1'}, {name : 'serviceofferingid', description : 'The service offering for the Instance', type : 'uuid', length : 255, required : True, related : 'updateServiceOffering'}, {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 : 'temppath', description : 'Temp Path on external host for disk image copy', type : 'string', length : 255, required : False}, {name : 'templateid', description : 'The ID of the Template for the Instance. Required when the instance to import is an unmanaged KVM Instance.', type : 'uuid', length : 255, required : False, related : 'listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate'}, {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 : 'nicnetworklist', description : 'VM NIC to network id mapping using keys NIC and network', type : 'map', length : 255, required : False}, {name : 'hostip', description : '(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.', type : 'string', length : 255, required : False}, {name : 'username', description : 'the username for the host', type : 'string', 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 : '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 : 'hostid', description : 'Host where local disk is located', 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 : 'projectid', description : 'Import Instance for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'host', description : 'the host name or IP address', type : 'string', length : 255, required : False}, {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. When usevddk and forceconverttopool are true, this can be an RBD primary storage pool for direct RBD import.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'password', description : 'the password for the host', type : 'string', length : 255, required : False}, {name : 'storageid', description : 'Shared storage pool where disk is located', type : 'uuid', length : 255, required : False, related : ''}, {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 : 'hypervisor', description : 'hypervisor type of the host', 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. With forceconverttopool=true and an RBD conversion pool, the source VMware VM must be powered off and the conversion host must support qemu RBD access and in-place virt-v2v finalization.', type : 'boolean', length : 255, required : False, since : '4.22.1'}, {name : 'clustername', description : '(only for importing VMs from VMware to KVM) Name of VMware cluster.', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'datadiskofferinglist', description : 'Datadisk Template to disk-offering mapping using keys disk and diskOffering', 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}], response : [{name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'userdataname', description : 'The name of userdata used for 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 : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'rootdevicetype', description : 'Device type of the root 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 : '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 : '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 : 'name', description : 'The name of the attached ISO', type : 'string'}]}, {}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'userdata', description : 'Base64 string containing the user data', 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 : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {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 : 'maxheads', description : 'the maximum number of display heads', 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 : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'projectid', description : 'The project 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 : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{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 : 'customer', description : 'Customer 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 : 'value', description : 'Tag value', 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 : '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 : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'securitygroupname', description : 'Security group name', 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 : 'icmptype', description : 'The type of the ICMP message response', 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 : '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 : 'domainpath', description : 'path of the Domain the security group belongs to', 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 : '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 : '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 : '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 : '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 : '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 : '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 : 'account', description : 'The Account owning 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 : '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 : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of 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 : 'resourceid', description : 'ID of the resource', 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 : '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 : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', 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 : '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 : '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 : 'account', description : 'Account owning the security group rule', type : 'string'}]}]}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {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 : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', 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 : '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 : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'name', description : 'The name 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 : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'domainid', description : 'The domain ID 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 : '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 : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {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'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'ipaddress', description : "the VM's primary IP address", 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 : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {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 : '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 : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', 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 : 'netmask', description : 'The netmask 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 : '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 : 'broadcasturi', description : 'The broadcast URI of the NIC', 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 : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', 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 : '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 : '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 : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', 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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}]}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', 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 : 'project', description : 'The project name where 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 : '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 : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}], httprequesttype : 'POST'}]
2026-10-27 14:51:03,460 - DEBUG - Payload: {'command': 'listAccounts', 'response': 'json', 'apiKey': 'uTvwB1RgbKKNifROZqNRyG37LlpF4kjTFsZ1C68kaHfKELaOqKnTc4PA52iVUikCC8UnyIKhXDFu4jZ-YgNHsg', 'signature': b'28R0MHpBqxmV4mLowIR4tmGdDtI='}
2026-10-27 14:51:03,461 - DEBUG - ========Sending GET Cmd : listAccounts=======
2026-10-27 14:51:03,498 - DEBUG - Response : [{id : '7643e094-b79d-4125-84b8-81a96a661a2f', name : 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', accounttype : 0, roleid : '307b7924-d097-4ea7-a44d-4483214cbbdd', roletype : 'User', rolename : 'MarvinFake Role mjotu8o59w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:50:56+0000', user : [{id : '2e18e2cb-62d3-462d-9d63-2c57ca74f054', username : 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:50:56+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls-UR8HFY', accounttype : 0, usersource : 'native', roleid : '307b7924-d097-4ea7-a44d-4483214cbbdd', roletype : 'User', rolename : 'MarvinFake Role mjotu8o59w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', apikey : 'uTvwB1RgbKKNifROZqNRyG37LlpF4kjTFsZ1C68kaHfKELaOqKnTc4PA52iVUikCC8UnyIKhXDFu4jZ-YgNHsg', accountid : '7643e094-b79d-4125-84b8-81a96a661a2f', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : []}]
2026-10-27 14:51:03,500 - DEBUG - Payload: {'command': 'listHosts', 'response': 'json', 'apiKey': 'uTvwB1RgbKKNifROZqNRyG37LlpF4kjTFsZ1C68kaHfKELaOqKnTc4PA52iVUikCC8UnyIKhXDFu4jZ-YgNHsg', 'signature': b'Do9DI/IQ3jlmm7/tdZaAwKhjp40='}
2026-10-27 14:51:03,500 - DEBUG - ========Sending GET Cmd : listHosts=======
2026-10-27 14:51:03,510 - 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-UR8HFY.\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-UR8HFY.
2026-10-27 14:51:03,510 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.listHosts.listHostsCmd object at 0x7f8d658186a0> 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-UR8HFY.\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-UR8HFY.
2026-10-27 14:51:03,510 - DEBUG - Payload: {'command': 'listZones', 'response': 'json', 'apiKey': 'uTvwB1RgbKKNifROZqNRyG37LlpF4kjTFsZ1C68kaHfKELaOqKnTc4PA52iVUikCC8UnyIKhXDFu4jZ-YgNHsg', 'signature': b'ike3bZb6pP9mfaEqq9x3dyTf8hc='}
2026-10-27 14:51:03,510 - DEBUG - ========Sending GET Cmd : listZones=======
2026-10-27 14:51:03,532 - 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-UR8HFY.\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-UR8HFY.
2026-10-27 14:51:03,533 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.listZones.listZonesCmd object at 0x7f8d65818e20> 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-UR8HFY.\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-UR8HFY.
2026-10-27 14:51:03,533 - DEBUG - Payload: {'id': '7643e094-b79d-4125-84b8-81a96a661a2f', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'kn9NyYVCZzQdpXg21owQUjdMFFI='}
2026-10-27 14:51:03,533 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:03,618 - DEBUG - === Jobid: a1a3902d-7991-4995-90a4-b7690ea5a1fe Started ===
2026-10-27 14:51:03,619 - DEBUG - Payload: {'jobid': 'a1a3902d-7991-4995-90a4-b7690ea5a1fe', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Lqw/8uexbgxIpiR5jMbZ5uhBNlw='}
2026-10-27 14:51:03,619 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:03,655 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '7643e094-b79d-4125-84b8-81a96a661a2f', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:04+0000', jobid : 'a1a3902d-7991-4995-90a4-b7690ea5a1fe', jobstatus : 0}
2026-10-27 14:51:04,657 - DEBUG - === JobId:a1a3902d-7991-4995-90a4-b7690ea5a1fe is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:04,658 - DEBUG - Payload: {'jobid': 'a1a3902d-7991-4995-90a4-b7690ea5a1fe', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Lqw/8uexbgxIpiR5jMbZ5uhBNlw='}
2026-10-27 14:51:04,658 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:04,720 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '7643e094-b79d-4125-84b8-81a96a661a2f', created : '2026-10-27T14:51:04+0000', completed : '2026-10-27T14:51:04+0000', jobid : 'a1a3902d-7991-4995-90a4-b7690ea5a1fe', jobstatus : 1}
2026-10-27 14:51:04,721 - DEBUG - ===Jobid:a1a3902d-7991-4995-90a4-b7690ea5a1fe ; StartTime:Tue Oct 27 14:51:03 2026 ; EndTime:Tue Oct 27 14:51:04 2026 ; TotalTime:-1===
2026-10-27 14:51:04,721 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '7643e094-b79d-4125-84b8-81a96a661a2f', created : '2026-10-27T14:51:04+0000', completed : '2026-10-27T14:51:04+0000', jobid : 'a1a3902d-7991-4995-90a4-b7690ea5a1fe', jobstatus : 1}
2026-10-27 14:51:04,722 - DEBUG - Payload: {'id': 'b8abc3c6-4103-4e81-9b7e-8b484171a38c', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'+8N2bAmV4aM5QPSkHg6sksnApyI='}
2026-10-27 14:51:04,722 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:04,819 - DEBUG - Response : {success : True}
2026-10-27 14:51:04,820 - DEBUG - Payload: {'id': '307b7924-d097-4ea7-a44d-4483214cbbdd', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'3FZy2okRBU6HSL8gz5TgTL2CicE='}
2026-10-27 14:51:04,820 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:04,865 - DEBUG - Response : {success : True}
2026-10-27 14:51:04,865 - DEBUG - TestCaseName: test_role_account_acls; Time Taken: 10 Seconds; StartTime: Tue Oct 27 14:50:54 2026; EndTime: Tue Oct 27 14:51:04 2026; Result: SUCCESS
2026-10-27 14:51:04,866 - DEBUG - ::::::::::::STARTED : TC: test_role_account_acls_multiple_mgmt_servers :::::::::::
2026-10-27 14:51:04,866 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:04,867 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:04,903 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:04,904 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role zai21exh9w', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'rDS8rErg76RYTYLMsicC7viZ2zE='}
2026-10-27 14:51:04,904 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:05,002 - DEBUG - Response : {type : 'User', state : 'enabled', id : '496f8f42-3f13-4ba6-bf33-031f66411fb9', name : 'MarvinFake Role zai21exh9w', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:05,004 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '496f8f42-3f13-4ba6-bf33-031f66411fb9', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'kIEJYWyQZCrcAYsRbts5mlgqhf0='}
2026-10-27 14:51:05,004 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:05,077 - DEBUG - Response : {id : '700ffd24-4786-4c26-8ce1-e8490d7f9b39', roleid : '496f8f42-3f13-4ba6-bf33-031f66411fb9', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:05,078 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '496f8f42-3f13-4ba6-bf33-031f66411fb9', 'username': 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'vfgzJCWqof4uqYBl041BjbosPWk='}
2026-10-27 14:51:05,078 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:05,988 - DEBUG - Response : {id : '55be664d-149b-4d60-8c49-8e00c9f038fa', name : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', accounttype : 0, roleid : '496f8f42-3f13-4ba6-bf33-031f66411fb9', roletype : 'User', rolename : 'MarvinFake Role zai21exh9w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:06+0000', user : [{id : '0e59585a-3dc3-49b9-a86c-f81dfa0f4047', username : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:06+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', accounttype : 0, usersource : 'native', roleid : '496f8f42-3f13-4ba6-bf33-031f66411fb9', roletype : 'User', rolename : 'MarvinFake Role zai21exh9w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : '55be664d-149b-4d60-8c49-8e00c9f038fa', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:05,988 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:05,989 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:06,011 - 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-27 14:51:11,224 - DEBUG - Payload: {'name': 'ROOT', 'command': 'listDomains', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'FUkLFPJq0p6AOaVYSkY//WIQFBk='}
2026-10-27 14:51:11,225 - DEBUG - ========Sending GET Cmd : listDomains=======
2026-10-27 14:51:11,255 - DEBUG - Response : [{id : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27 14:51:11,256 - DEBUG - Payload: {'listall': True, 'name': 'ROOT', 'command': 'listDomains', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'MTo4M/OsRVaY9H/KZqvgm9hNmEQ='}
2026-10-27 14:51:11,256 - DEBUG - ========Sending GET Cmd : listDomains=======
2026-10-27 14:51:11,279 - DEBUG - Response : [{id : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27 14:51:11,280 - DEBUG - Payload: {'domainid': '54e5326a-d1fe-11f1-81aa-1e0044000301', 'listall': True, 'name': 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', 'command': 'listAccounts', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'eoNz37/Jne7cptSe+ZivO+ixcQ4='}
2026-10-27 14:51:11,280 - DEBUG - ========Sending GET Cmd : listAccounts=======
2026-10-27 14:51:11,312 - DEBUG - Response : [{id : '55be664d-149b-4d60-8c49-8e00c9f038fa', name : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', accounttype : 0, roleid : '496f8f42-3f13-4ba6-bf33-031f66411fb9', roletype : 'User', rolename : 'MarvinFake Role zai21exh9w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:06+0000', user : [{id : '0e59585a-3dc3-49b9-a86c-f81dfa0f4047', username : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:06+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', accounttype : 0, usersource : 'native', roleid : '496f8f42-3f13-4ba6-bf33-031f66411fb9', roletype : 'User', rolename : 'MarvinFake Role zai21exh9w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : '55be664d-149b-4d60-8c49-8e00c9f038fa', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}]
2026-10-27 14:51:11,313 - DEBUG - Payload: {'domainid': '54e5326a-d1fe-11f1-81aa-1e0044000301', 'listall': True, 'username': 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', 'command': 'listUsers', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'CE1Gvg/Z0cd2JxPcgRe+pWmWuio='}
2026-10-27 14:51:11,313 - DEBUG - ========Sending GET Cmd : listUsers=======
2026-10-27 14:51:11,335 - DEBUG - Response : [{id : '0e59585a-3dc3-49b9-a86c-f81dfa0f4047', username : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:06+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', accounttype : 0, usersource : 'native', roleid : '496f8f42-3f13-4ba6-bf33-031f66411fb9', roletype : 'User', rolename : 'MarvinFake Role zai21exh9w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : '55be664d-149b-4d60-8c49-8e00c9f038fa', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False, apikeyaccess : 'INHERIT'}]
2026-10-27 14:51:11,335 - DEBUG - Payload: {'id': '0e59585a-3dc3-49b9-a86c-f81dfa0f4047', 'command': 'getUserKeys', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'TrLQINO2AMeHUipB8/PKbNBe1CY='}
2026-10-27 14:51:11,336 - DEBUG - ========Sending GET Cmd : getUserKeys=======
2026-10-27 14:51:11,352 - DEBUG - Response : {apikeyaccess : True}
2026-10-27 14:51:11,353 - ERROR - __createApiClient: API Client Creation Failed
2026-10-27 14:51:11,353 - DEBUG - Payload: {'id': '0e59585a-3dc3-49b9-a86c-f81dfa0f4047', 'name': 'keypair-0e59585a-3dc3-49b9-a86c-f81dfa0f4047', 'command': 'registerUserKeys', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'6Oc+JKseGfMbmRQyQYoUU4iw/ww='}
2026-10-27 14:51:11,353 - DEBUG - ========Sending GET Cmd : registerUserKeys=======
2026-10-27 14:51:12,872 - DEBUG - Response : {name : 'keypair-0e59585a-3dc3-49b9-a86c-f81dfa0f4047', apikey : 'G1V7YeInTB6ZliRjJwwa0YtCecfo8CcjTIXGYJhvJdMiANFByzv1_tKwcKue4nOQFhcxR0yOq9kGTynSF7xioQ', secretkey : 'mQOppCBNxBsft_lMLNns4T4FUg-RsIajaKlUKcl1uy9SuiDAdPBn2FTbwo6V5q9144d_bpfDf-oowNHb-atMpQ', userid : '0e59585a-3dc3-49b9-a86c-f81dfa0f4047', username : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', id : 'a9cc929f-84a1-435a-8dda-d5de207b6cd5', created : '2026-10-27T14:51:13+0000', accounttype : 'NORMAL', accountid : '55be664d-149b-4d60-8c49-8e00c9f038fa', accountname : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', roleid : '496f8f42-3f13-4ba6-bf33-031f66411fb9', roletype : 'User', rolename : 'MarvinFake Role zai21exh9w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', domainpath : 'ROOT', state : 'ENABLED'}
2026-10-27 14:51:12,873 - DEBUG - Payload: {'id': '0e59585a-3dc3-49b9-a86c-f81dfa0f4047', 'command': 'getUserKeys', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'TrLQINO2AMeHUipB8/PKbNBe1CY='}
2026-10-27 14:51:12,873 - DEBUG - ========Sending GET Cmd : getUserKeys=======
2026-10-27 14:51:13,036 - DEBUG - Response : {apikey : 'G1V7YeInTB6ZliRjJwwa0YtCecfo8CcjTIXGYJhvJdMiANFByzv1_tKwcKue4nOQFhcxR0yOq9kGTynSF7xioQ', secretkey : 'mQOppCBNxBsft_lMLNns4T4FUg-RsIajaKlUKcl1uy9SuiDAdPBn2FTbwo6V5q9144d_bpfDf-oowNHb-atMpQ', apikeyaccess : True}
2026-10-27 14:51:13,036 - DEBUG - Payload: {'command': 'listApis', 'response': 'json', 'apiKey': 'G1V7YeInTB6ZliRjJwwa0YtCecfo8CcjTIXGYJhvJdMiANFByzv1_tKwcKue4nOQFhcxR0yOq9kGTynSF7xioQ', 'signature': b'6g7+6yCi8LRdgNO0KxtpIaJaMmc='}
2026-10-27 14:51:13,037 - DEBUG - ========Sending GET Cmd : listApis=======
2026-10-27 14:51:13,462 - 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 : '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 : 'deleteVmwareCbtMigration', description : 'Deletes a failed, cancelled or completed VMware CBT migration record. Failed and cancelled migrations can optionally clean up replicated target disks; completed migrations are record-only deletes.', since : '4.24.0', isasync : False, params : [{name : 'id', description : 'the VMware CBT migration ID', type : 'uuid', length : 255, required : True, related : 'startVmwareCbtMigration,listVmwareCbtMigrations,syncVmwareCbtMigration,cutoverVmwareCbtMigration,cancelVmwareCbtMigration'}, {name : 'cleanup', description : 'If true, clean up replicated target disks before removing a failed or cancelled migration record. True by default. Ignored for completed migrations.', 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 : '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'}], 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 : '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 : 'rebootSystemVm', description : 'Reboots a system VM.', isasync : True, related : 'destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm', params : [{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'}, {name : 'id', description : 'The ID of the System VM', type : 'uuid', length : 255, required : True, related : 'destroySystemVm,listSystemVms,migrateSystemVm,rebootSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm'}], response : [{name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the System VM', 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 : '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 : 'hypervisor', description : 'The hypervisor on which the Template runs', 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 : '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 : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'agentstate', description : 'The agent 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 : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID 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 : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', 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 : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'podname', description : 'The Pod name 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 : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {}, {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 : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'linklocalmacaddress', description : 'The link local MAC address 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 : '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'}, {name : 'id', description : 'the ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster,removeNodesFromKubernetesCluster,updateKubernetesClusterAffinityGroups'}], response : [{name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'name', description : 'The name 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 : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID 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 : '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 : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {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 : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'controlofferingname', description : 'the name 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 : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'networkid', description : 'The ID of the network of 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 : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd 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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of 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 : '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 : '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 : 'id', description : 'the ID of the OAuth provider', type : 'uuid', length : 255, required : False, related : 'listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'provider', description : 'Name of the provider', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'name', description : 'Name of the provider', type : 'string'}, {name : 'tokenurl', description : 'Token URL registered in the OAuth provider', type : 'string'}, {name : 'secretkey', description : 'Secret key registered in the OAuth provider', type : 'string'}, {name : 'authorizeurl', description : 'Authorize URL registered in the OAuth provider', type : 'string'}, {name : 'redirecturi', description : 'Redirect URI registered in the OAuth provider', type : 'string'}, {name : 'id', description : 'ID of the provider', type : 'string'}, {name : 'clientid', description : 'Client ID registered in the OAuth provider', type : 'string'}, {name : 'domain', description : 'name of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'domainid', description : 'UUID 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 : '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 : 'description', description : 'Description of the provider registered', 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 : 'updateSharedFileSystem', description : 'Update a Shared FileSystem', since : '4.20.0', isasync : False, related : 'createSharedFileSystem,listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering', params : [{name : 'name', description : 'the name of the shared filesystem.', type : 'string', length : 255, required : False}, {name : 'description', description : 'the description for 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 : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'volumename', description : 'name of the storage fs data volume', 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 : '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 : '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 : 'key', description : 'Tag key name', 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 : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'zoneid', description : 'ID of the availability zone', 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 : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'domain', description : 'the domain associated with 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 : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {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 : '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 : 'isolationuri', description : 'The isolation URI of the NIC', 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 : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {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 : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', 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 : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'id', description : 'The ID of the NIC', 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 : 'networkname', description : 'The name of the corresponding Network', 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 : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 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 : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}]}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'utilization', description : 'the disk utilization', 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 : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with 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 : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'privateip', description : 'The private IP 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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {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 : '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 : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', 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 : '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 : '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 : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {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 : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}], httprequesttype : 'POST'}, {name : 'listASNumbers', description : 'List Autonomous Systems Numbers', since : '4.20.0', isasync : False, related : '', params : [{name : 'keyword', description : 'List by keyword', type : 'string', 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 : 'asnrangeid', description : 'the AS Number range ID', type : 'uuid', length : 255, required : False, related : 'createASNRange,listASNRanges'}, {name : 'asnumber', description : 'AS number', type : 'integer', length : 255, required : False, related : 'listASNumbers'}, {name : 'account', description : 'account name', type : 'string', length : 255, required : False, related : 'createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts'}, {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 : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'domainid', description : 'domain id', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'isallocated', description : 'to indicate if the AS number is allocated to any network', type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'vpcname', description : 'VPC Name', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'allocationstate', description : 'Allocation state', type : 'string'}, {name : 'asnumber', description : 'AS Number', type : 'long'}, {}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'allocated', description : 'Allocated Date', type : 'date'}, {name : 'asnrange', description : 'AS Number Range', type : 'string'}, {name : 'id', description : 'ID of the AS Number', type : 'string'}, {name : 'created', description : 'Created Date', type : 'date'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'asnrangeid', description : 'AS Number ID', type : 'string'}, {name : 'domain', description : 'the domain name', type : 'string'}, {name : 'accountid', description : 'Account ID', type : 'string'}, {name : 'associatednetworkid', description : 'Network ID', type : 'string'}, {name : 'associatednetworkname', description : 'Network Name', type : 'string'}, {name : 'vpcid', description : 'VPC ID', type : 'string'}, {name : 'zonename', description : 'the zone name of the AS Number range', type : 'string'}, {name : 'domainid', description : 'Domain ID', type : 'string'}], httprequesttype : 'GET'}, {name : 'listUserData', description : 'List registered userdatas', since : '4.18', isasync : False, related : 'listCniConfiguration', params : [{name : 'id', description : 'The ID of the Userdata', type : 'uuid', length : 255, required : False, related : 'listUserData,listCniConfiguration'}, {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 : '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 : '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 : '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,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}], response : [{}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'Name of the User Data', type : 'string'}, {name : 'domain', description : 'The domain name of the User Data owner', type : 'string'}, {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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'account', description : 'The owner of the User Data', type : 'string'}, {name : 'domainid', description : 'The domain id of the User Data owner', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the User Data owner belongs', type : 'string'}, {name : 'projectid', description : 'The project id of the User Data', type : 'string'}, {name : 'userdata', description : 'Base64 encoded User Data content', type : 'string'}, {name : 'id', description : 'ID of the User Data', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {}, {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'}], 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 : 'id', description : 'The ID of the system vm', type : 'uuid', length : 255, required : True, related : 'listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm'}, {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 : 'serviceofferingid', description : 'The service offering ID to apply to the system vm', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,cloneServiceOffering,updateServiceOffering,listServiceOfferings'}], response : [{name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'arch', description : 'CPU arch of 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 : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {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 : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {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 : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {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 : '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 : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', 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 : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}], 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 : '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 : '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'}, {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'}, {name : 'secretcode', description : 'Code that is provided by OAuth provider (Eg. google, github) after successful login', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{}, {name : 'domain', description : 'name of the domain the provider belongs to (empty for global)', type : 'string'}, {}, {name : 'domainpath', description : 'path of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'domainid', description : 'UUID of the domain the provider belongs to (empty for global)', type : 'string'}, {name : 'tokenurl', description : 'Token URL registered in the OAuth provider', type : 'string'}, {name : 'id', description : 'ID of the provider', type : 'string'}, {name : 'description', description : 'Description of the provider registered', type : 'string'}, {name : 'secretkey', description : 'Secret key registered in the OAuth provider', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'redirecturi', description : 'Redirect URI registered in the OAuth 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'}, {name : 'name', description : 'Name of the provider', 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 : 'provider', description : 'Name of the provider', type : 'string'}], httprequesttype : 'GET'}, {name : 'createBackupSchedule', description : 'Creates a User-defined Instance backup schedule', since : '4.14.0', isasync : False, related : 'listBackupSchedule', 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 : '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 : '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,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 : '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'}], response : [{}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'intervaltype', description : 'The interval type of the backup schedule', type : 'intervaltype'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'schedule', description : 'The time the backup is scheduled to be taken.', type : 'string'}, {name : 'timezone', description : 'The time zone 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 : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {}, {name : 'maxbackups', description : 'maximum number of backups retained', type : 'integer'}, {name : 'id', description : 'ID of the backup schedule.', type : 'string'}, {name : 'quiescevm', description : 'quiesce the instance before checkpointing the disks for backup', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listKMSKeys', description : 'Lists KMS keys available to the caller', since : '4.23.0', isasync : False, related : 'createKMSKey,updateKMSKey', 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 : '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 : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {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 : '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 : '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 : 'zoneid', description : 'Filter by zone ID', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,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}], response : [{name : 'zoneid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'enabled', description : 'whether the key is enabled', type : 'boolean'}, {name : 'algorithm', description : 'the encryption algorithm', type : 'string'}, {name : 'id', description : 'the UUID of the key', type : 'string'}, {name : 'domainpath', description : 'the domain path of the key', type : 'string'}, {name : 'version', description : 'the key size in bits', type : 'integer'}, {name : 'hsmprofileid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'project', description : 'the project name of the key', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', 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 : 'domain', description : 'the domain name of the key', type : 'string'}, {}, {name : 'created', description : 'the creation timestamp', type : 'date'}, {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 : 'accountid', description : 'the account ID owning the key', type : 'string'}, {name : 'domainid', description : 'the domain ID of the key', type : 'string'}, {name : 'keybits', description : 'the key size in bits', type : 'integer'}, {name : 'projectid', description : 'the project ID of the key', type : 'string'}, {name : 'description', description : 'the description of the key', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'cleanVMReservations', description : 'Cleanups Instance reservations in the database.', isasync : True, params : [], 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 : 'updateRoutingFirewallRule', description : 'Updates Routing firewall rule with specified ID', since : '4.20.0', isasync : True, related : 'createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule', params : [{name : 'id', description : 'the ID of the Routing firewall rule', type : 'uuid', length : 255, required : True, related : 'createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule'}, {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 : '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 : 'privateendport', description : "The ending port of port forwarding rule's private port range", 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 : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', 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 : 'domainid', description : 'The ID 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 : 'domain', description : '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 : '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 : 'projectid', description : 'The project ID the tag belongs to', 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 : 'networkid', description : 'The ID of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'virtualmachinedisplayname', description : 'The Instance display 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 : 'state', description : 'The state of the rule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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 : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'listObjectStoragePools', description : 'Lists object storage pools.', since : '4.19.0', isasync : False, related : 'addObjectStoragePool,updateObjectStoragePool', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'the ID of the storage pool', type : 'uuid', length : 255, required : False, related : 'addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'provider', description : 'the object store provider', type : 'string', length : 255, required : False}, {name : 'name', description : 'the name of the object store', type : 'string', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'storagetotal', description : 'the total size of the object store', type : 'long'}, {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 : 'storageallocated', description : 'the allocated size of the object store', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'storageused', description : 'the object store currently used size', type : 'long'}, {name : 'id', description : 'the ID of the object store', type : 'string'}, {name : 'url', description : 'the url of the object store', type : 'string'}, {}, {name : 'name', description : 'the name of the object store', type : 'string'}, {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 : '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'}, {}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'runCustomAction', description : 'Run the custom action', since : '4.21.0', isasync : True, related : '', params : [{name : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : False}, {name : 'customactionid', description : 'ID of the custom action', type : 'uuid', length : 255, required : True, related : 'addCustomAction,listCustomActions'}, {name : 'resourceid', description : 'ID of the instance', type : 'string', length : 255, required : True}, {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 : 'name', description : 'Name of the action', type : 'string'}, {name : 'success', description : 'Whether custom action succeed or not', type : 'boolean'}, {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'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], httprequesttype : 'POST'}, {name : 'listDnsRecords', description : 'Lists DNS records from the external provider', since : '4.23.0', isasync : False, related : 'createDnsRecord', params : [{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'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{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'}, {}, {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'}], httprequesttype : 'GET'}, {name : 'createBackup', description : 'Create Instance backup', since : '4.14.0', isasync : True, params : [{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 : 'name', description : 'the name of the backup', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'description', description : 'the description for the backup', type : 'string', length : 255, required : False, since : '4.21.0'}, {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 : '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'}], 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 : '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 : '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 : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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 : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'id', description : 'The ID of 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 : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'hostid', description : 'The host 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 : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'serviceofferingname', description : 'the name 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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}], httprequesttype : 'POST'}, {name : 'listIpv6FirewallRules', description : 'Lists all IPv6 firewall rules', isasync : False, related : 'createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule', params : [{name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', 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 : '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 : '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 : 'page', 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 : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain'}, {name : 'id', description : 'Lists IPv6 firewall rule with the specified ID', type : 'uuid', length : 255, required : False, related : 'createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule'}, {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 : 'fordisplay', description : 'List resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{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 : 'value', description : 'Tag value', 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 : 'customer', description : 'Customer 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 : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', 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 : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', 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 : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'protocol', description : 'The protocol of the port forwarding rule', 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 : 'privateendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {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 : 'networkname', description : 'The Name 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}], httprequesttype : 'GET'}, {name : 'listVMSchedule', description : 'List Instance Schedules.', since : '4.19.0', isasync : False, related : 'createVMSchedule,updateVMSchedule', params : [{name : 'enabled', description : 'Filter by enabled status', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'ID of Instance schedule', type : 'uuid', length : 255, required : False, related : 'createVMSchedule,listVMSchedule,updateVMSchedule'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'action', description : 'Action taken by schedule', type : 'string', 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 : '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'}], response : [{name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'action', description : 'Action', type : 'action'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'The ID of Instance schedule', type : 'string'}, {}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {}, {name : 'description', description : 'Description of Instance schedule', type : 'string'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'schedule', description : 'Cron formatted Instance schedule', type : 'string'}, {name : 'enabled', description : 'VM schedule is enabled', type : 'boolean'}, {name : 'virtualmachineid', description : 'ID of Instance', 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'}], 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 : '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 : '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 : '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 : '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 : '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}, {name : 'mountcksisoonvr', description : '(optional) Vmware only, uses the CKS cluster network VR to mount the CKS ISO', type : 'boolean', length : 255, required : False}], response : [{name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {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 : 'workerofferingid', description : 'the ID of the service offering of the worker nodes on 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 : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of 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 : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'memory', description : 'The memory the Kubernetes cluster', 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 : 'workerofferingname', description : 'the name of the service offering of the worker nodes on the Kubernetes cluster', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {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 : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {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 : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'name', description : 'The name 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 : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the 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 : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupids', description : 'The IDs 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'}, {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 : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}], httprequesttype : 'POST'}, {name : 'listVolumesMetrics', description : 'Lists volume metrics', since : '4.9.3', isasync : False, related : '', params : [{name : 'diskofferingid', description : 'List volumes by disk offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'createDiskOffering,cloneDiskOffering,updateDiskOffering,listDiskOfferings'}, {name : 'name', description : 'The name of the disk volume', 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 : 'zoneid', description : 'The ID of the availability zone', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'page', description : '', type : 'integer', 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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The ID of the disk volume', type : 'uuid', length : 255, required : False, related : 'importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}, {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 : '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 : 'type', description : 'The type of disk volume', type : 'string', length : 255, required : False}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', 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 : '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 : '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 : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'isencrypted', description : 'list only volumes that are encrypted', type : 'boolean', length : 255, required : False, since : '4.19.1'}, {name : 'state', description : 'State of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.', type : 'string', 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 : 'importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}, {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 : 'hostid', description : 'List volumes on specified host', type : 'uuid', length : 255, required : False, related : 'addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost'}, {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 : 'clusterid', description : 'The cluster ID the disk volume belongs to', type : 'uuid', length : 255, required : False, related : 'addCluster,updateCluster'}, {name : 'podid', description : 'The pod ID the disk volume belongs to', type : 'uuid', length : 255, required : False, related : 'createPod,listPods,updatePod,createManagementNetworkIpRange'}, {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 : 'listsystemvms', description : 'List system VMs; only ROOT admin is eligible to pass this parameter', type : 'boolean', length : 255, required : False, since : '4.18'}], response : [{name : 'diskiopstotal', description : 'The total disk iops', type : 'long'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {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 : 'isoid', description : 'The ID 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 : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'sizegb', description : 'Disk size in GiB', type : 'string'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'state', description : 'The state of the disk volume', 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 : 'value', description : 'Tag value', type : 'string'}, {name : 'domain', description : '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 : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', 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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', 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 : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', 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 : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', 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 : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'vmstate', description : 'State of the Instance', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}], 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 : '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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{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 : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {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 : 'name', description : 'The name of the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', 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 : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}]}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'ostypeid', description : 'OS type id 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 : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', 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 : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", 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 : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {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 : '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 : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {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 : 'type', description : 'The type of the NIC', 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 : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', 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 : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', 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 : '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 : '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 : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', 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 : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', 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 : '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 : '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 : '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 : '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 : '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 : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', 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 : 'value', description : 'Tag value', 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 : 'securitygroupname', description : 'Security group name', type : 'string'}]}, {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 : 'account', description : 'The Account owning the security group', type : 'string'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'name', description : 'The name of the security group', type : 'string'}, {name : 'projectid', description : 'The project id 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 : '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 : '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 : 'key', description : 'Tag key name', 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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', 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 : '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 : 'endport', description : 'The ending 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 : '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 : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {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 : 'domainpath', description : 'Path 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 : 'projectid', description : 'The project ID the tag belongs to', 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 name of the security group', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {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 : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', 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 : '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 : 'id', description : 'The ID of the attached ISO', type : 'string'}, {name : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'bootable', description : 'Whether this is the bootable ISO for the VM', type : 'boolean'}]}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', 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 : 'name', description : 'The name of the Instance', type : 'string'}, {}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {}, {name : 'serviceofferingid', description : 'The ID of the service offering of 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 : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'pooltype', description : 'The pool type 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'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", 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 : '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 : '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 : '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 : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', 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 : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', 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 : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'rootdevicetype', description : 'Device type of the root volume', 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 : 'ip6dns1', description : 'The first IPv6 DNS for the router', type : 'string'}, {name : 'vpcid', description : 'VPC the router belongs to', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the router', type : 'string'}, {name : 'publicnetworkid', description : 'The ID of the corresponding public Network', type : 'string'}, {name : 'id', description : 'The ID of the router', type : 'string'}, {name : 'hostname', description : 'The hostname for the router', type : 'string'}, {name : 'healthchecksfailed', description : 'True if any health checks had failed', type : 'boolean'}, {name : 'redundantstate', description : 'The state of redundant virtual router', type : 'string'}, {name : 'gateway', description : 'The gateway for the router', type : 'string'}, {name : 'publicip', description : 'The public IP address for the router', type : 'string'}, {name : 'guestmacaddress', description : 'The guest MAC address for the router', type : 'string'}, {name : 'account', description : 'The Account associated with the router', type : 'string'}, {name : 'podid', description : 'The Pod ID for the router', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the router belongs to', type : 'string'}, {name : 'guestnetmask', description : 'The guest netmask for the router', type : 'string'}, {name : 'hostid', description : 'The host ID for the router', 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 : 'linklocalnetworkid', description : 'The ID of the corresponding link local Network', type : 'string'}, {name : 'ip6dns2', description : 'The second IPv6 DNS for the router', 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 : 'linklocalnetmask', description : 'The link local netmask for the router', type : 'string'}, {name : 'templateid', description : 'The Template ID for the router', type : 'string'}, {name : 'domainid', description : 'The domain ID associated with the router', type : 'string'}, {name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {}, {name : 'requiresupgrade', description : 'True if the router Template requires upgrade', type : 'boolean'}, {name : 'role', description : 'Role of the domain router', type : 'string'}, {name : 'publicmacaddress', description : 'The public 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 : 'healthcheckresults', description : 'Last executed health check result for the router', type : 'list', response : [{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 : '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 : 'status', description : 'the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}', type : 'routerhealthstatus'}, {name : 'lastupdated', description : 'The date this VPC was created', type : 'date'}]}, {name : 'dns2', description : 'The second DNS for the router', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'project', description : 'The project name of the address', type : 'string'}, {name : 'state', description : 'The state of the router', type : 'state'}, {name : 'isredundantrouter', description : 'If this router is an redundant virtual router', type : 'boolean'}, {name : 'guestnetworkid', description : 'The ID of the corresponding guest Network', type : 'string'}, {name : 'version', description : 'The version of Template', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the router', type : 'string'}, {name : 'guestnetworkname', description : 'The name of the corresponding guest Network', 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 router', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with the router', type : 'set', response : [{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 : '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 : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {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 : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding 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 : '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 : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', 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 : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', 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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'traffictype', description : 'The traffic type 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 : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', 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 : 'hostcontrolstate', description : 'The control state of the host for the router', 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 : 'guestipaddress', description : 'The guest IP address for the router', type : 'string'}, {name : 'podname', description : 'The Pod name for the router', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the router', type : 'string'}, {name : 'templatename', description : 'The Template name for the router', type : 'string'}, {name : 'domain', description : 'The domain associated with the router', type : 'string'}, {name : 'arch', description : 'CPU arch of the router', type : 'string'}, {name : 'softwareversion', description : 'The version of the code / software in the router', type : 'string'}, {name : 'scriptsversion', description : 'The version of scripts', type : 'string'}, {name : 'name', description : 'The name of 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 : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {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}], 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 : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'displaytext', description : 'Any text associated with the success or failure', type : 'string'}], httprequesttype : 'POST'}, {name : 'listKubernetesClusters', description : 'Lists Kubernetes clusters', isasync : False, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'page', description : '', type : 'integer', 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}, {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 : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : False, related : 'createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {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 Kubernetes cluster', 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 : 'clustertype', description : 'Type of the cluster: CloudManaged, ExternalManaged', type : 'string', length : 255, required : False, since : '4.19.0'}, {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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {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}], response : [{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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', 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 Kubernetes cluster', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'templatename', description : 'the name of the template 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 : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {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 : 'controlofferingname', description : 'the name 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 : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {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 : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', 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 : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'endpoint', description : 'URL end point for 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 : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {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 : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {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 : 'description', description : 'The description 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 : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', 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 : '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 : '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 : 'scaledownpolicyids', description : 'List of scaledown autoscale policies', type : 'list', length : 255, required : True, related : 'listAutoScalePolicies,updateAutoScalePolicy'}, {name : 'lbruleid', description : 'The ID of the load balancer rule', type : 'uuid', length : 255, required : True, related : 'createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule'}, {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 : 'interval', description : 'The frequency in which the performance counters to be collected', type : 'integer', length : 255, required : False}, {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}], response : [{name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {name : 'publicipid', description : 'The public IP address ID', type : 'string'}, {name : 'projectid', description : 'The project id of the Instance group', type : 'string'}, {name : 'publicip', description : 'The public IP address', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {name : 'privateport', description : 'The private port', type : 'string'}, {}, {name : 'publicport', description : 'The public port', type : 'string'}, {name : 'lbprovider', description : 'The LB provider of the guest Network the LB rule belongs to', 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 : '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 : '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 : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'associatednetworkname', description : 'The name of the guest Network the LB rule belongs to', type : 'string'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {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 : '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 : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}], httprequesttype : 'POST'}, {name : 'createNetworkPermissions', description : 'Updates network permissions.', since : '4.17.0', isasync : False, params : [{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'}, {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'}], 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 : '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 : '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 : '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 : 'importVolume,attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume', params : [{name : 'repair', description : 'parameter to repair the volume, leaks or all are the possible values', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the volume', type : 'uuid', length : 255, required : True, related : 'importVolume,attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}], response : [{name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', 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 : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', 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 : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {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 : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', 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 : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'vmstate', description : 'State 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 : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {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 : 'key', description : 'Tag key name', type : 'string'}, {name : 'domain', description : 'The domain 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 : 'customer', description : 'Customer associated with the tag', 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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}], 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 : '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 : '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 : '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 : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'publicport', description : 'The public port', 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 : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'project', description : 'The project name of the 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 : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}, {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 : 'name', description : 'The name of the autoscale 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 : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the guest Network the LB rule belongs to', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domainid', description : 'The domain ID 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 : '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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'publicip', description : 'The public IP address', 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'}], httprequesttype : 'POST'}, {name : 'listSystemVms', description : 'List System VMs.', isasync : False, related : 'migrateSystemVm,startSystemVm,changeServiceForSystemVm', params : [{name : 'arch', description : 'CPU arch of the system VM', type : 'string', length : 255, required : False, since : '4.20.1'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {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 : 'name', description : 'The name of the system VM', type : 'string', 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 : 'addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost'}, {name : 'systemvmtype', description : 'The system VM type. Possible types are "consoleproxy" and "secondarystoragevm".', type : 'string', length : 255, required : False}, {name : 'podid', description : 'The Pod ID of the system VM', type : 'uuid', length : 255, required : False, related : 'createPod,listPods,updatePod,createManagementNetworkIpRange'}, {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 : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'state', description : 'The state of the system VM', type : 'string', length : 255, required : False}], response : [{name : 'agentstate', description : 'The agent state of 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 : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {}, {name : 'privatemacaddress', description : 'The private MAC address 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 : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'dns2', description : 'The second DNS 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 : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', 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 : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', 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 : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}], httprequesttype : 'GET'}, {name : 'listInstanceBootGroupReadinessRules', description : 'Lists readiness rules for an Instance Boot Group', since : '24.0', isasync : False, related : 'createInstanceBootGroupReadinessRule,updateInstanceBootGroupReadinessRule', params : [{name : 'virtualmachineid', description : 'List rules for 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,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 : 'ruletype', description : 'Filter by readiness rule type', type : 'string', 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 : 'bootgroupid', description : 'The ID of the Instance Boot Group; listing is always scoped to one boot group', type : 'uuid', length : 255, required : True, related : 'createInstanceBootGroup,updateInstanceBootGroup,listInstanceBootGroups,startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup'}, {name : 'id', description : 'List by readiness rule ID', type : 'uuid', length : 255, required : False, related : 'createInstanceBootGroupReadinessRule,updateInstanceBootGroupReadinessRule,listInstanceBootGroupReadinessRules'}, {name : 'instancegroupid', description : 'List rules for the Instance Group', type : 'uuid', length : 255, required : False, related : 'createInstanceGroup,updateInstanceGroup'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'name', description : 'The name of the readiness rule', type : 'string'}, {}, {name : 'memberid', description : 'The ID of the item (VM or instance group) this rule applies to', type : 'string'}, {name : 'statusmessage', description : 'The message from the last evaluation of this rule', type : 'string'}, {name : 'details', description : 'Rule-type-specific configuration', type : 'map'}, {name : 'checkedon', description : 'When this rule was last evaluated', type : 'date'}, {name : 'membertype', description : 'The item type this rule applies to: VirtualMachine or InstanceGroup', type : 'string'}, {name : 'membername', description : 'The name of the item (VM or instance group) this rule applies to', type : 'string'}, {name : 'readinessstatus', description : 'The last cached evaluation status of this rule: READY, NOT_READY, ERROR or UNKNOWN', type : 'string'}, {name : 'enabled', description : 'Whether the rule is enabled', type : 'boolean'}, {name : 'id', description : 'The ID of the readiness rule', type : 'string'}, {}, {name : 'bootgroupid', description : 'The ID of the boot group this rule belongs to', type : 'string'}, {name : 'ruletype', description : 'The readiness rule type', type : 'string'}, {name : 'created', description : 'The date the rule was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'inherited', description : "True if this rule is not attached to the queried item directly, but inherited from its owning InstanceGroup (only possible when listing by virtualmachineid; the rule's itemtype/itemid still refer to the InstanceGroup it's actually attached to)", type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'createVMSchedule', description : 'Create Instance Schedule', since : '4.19.0', isasync : False, related : 'updateVMSchedule', params : [{name : 'action', description : 'Action to take on the Instance (start/stop/reboot/force_stop/force_reboot).', type : 'string', length : 255, required : True}, {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 : '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 : '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 : '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 : 'enabled', description : 'Enable Instance schedule. Defaults to true', type : 'boolean', length : 255, required : False}, {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}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {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 : '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 : '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 : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {}, {name : 'id', description : 'The ID of Instance schedule', type : 'string'}], 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 : '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 : 'enabled', description : 'Enable schedule. Defaults to true', type : 'boolean', length : 255, required : False}, {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 : 'resourcetype', description : 'Type of the resource', type : 'string', length : 255, required : True}, {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 : 'action', description : 'Action to take on the resource.', type : 'string', length : 255, required : True}, {name : 'description', description : 'Description of the schedule', type : 'string', length : 255, required : False}, {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}], response : [{name : 'action', description : 'Action', type : 'action'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {}, {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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'enabled', description : 'Resource schedule is enabled', type : 'boolean'}, {name : 'details', description : 'Schedule details', type : 'map'}, {name : 'id', description : 'The ID of resource schedule', type : 'string'}, {name : 'resourcetype', description : 'Type of the resource', type : 'apicommandresourcetype'}, {name : 'schedule', description : 'Cron formatted resource schedule', type : 'string'}, {name : 'description', description : 'Description of resource schedule', type : 'string'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'timezone', description : 'Timezone of the 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 : '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 : '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 : '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 : 'description', description : 'the description for the shared filesystem.', type : 'string', length : 255, required : False}, {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 : 'name', description : 'the name of the shared filesystem.', type : 'string', length : 255, required : True}, {name : 'account', description : 'the account associated with the shared filesystem. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {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 : 'size', description : 'the size of the shared filesystem in GiB', 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 : 'miniops', description : 'min iops', type : 'long', length : 255, required : False}, {name : 'zoneid', description : 'the zone id.', type : 'uuid', length : 255, required : True, related : 'createZone,updateZone,listZones,listZones'}, {name : 'maxiops', description : 'max iops', type : 'long', length : 255, required : False}], response : [{name : 'domain', description : '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 : '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 : '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 : '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 : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}]}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', 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 : '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 : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', 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 : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {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 : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID 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 : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {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 : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {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 : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {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 : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'project', description : 'the project name of 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 : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', 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 shared filesystem', type : 'string'}, {name : 'id', description : 'ID of 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 : '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 : 'updateVmwareDc', description : 'Updates a VMware datacenter details for a zone', since : '4.12.0', isasync : False, related : 'addVmwareDc,listVmwareDcs', params : [{name : 'name', description : 'VMware datacenter name.', type : 'string', length : 255, required : False}, {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}], response : [{name : 'id', description : 'The VMware Datacenter ID', type : 'string'}, {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'}, {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 : '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 : '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 : 'updateInstanceBootGroup', description : 'Updates an Instance Boot Group', since : '24.0', isasync : False, related : 'createInstanceBootGroup,listInstanceBootGroups,startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup', params : [{name : 'name', description : 'New name for the Instance Boot Group', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the Instance Boot Group', type : 'uuid', length : 255, required : True, related : 'createInstanceBootGroup,updateInstanceBootGroup,listInstanceBootGroups,startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup'}, {name : 'readinessrebootonretry', description : 'Per-boot-group override of whether an instance is rebooted between readiness retry attempts', type : 'boolean', length : 255, required : False}, {name : 'readinessinitialdelayseconds', description : 'Per-boot-group override of the global delay (seconds) after starting or rebooting an instance before its first readiness check of that attempt. Pass -1 to clear the override and fall back to the global setting', type : 'long', length : 255, required : False}, {name : 'readinessattempttimeoutseconds', description : 'Per-boot-group override of the global timeout (seconds) for each readiness retry attempt. Pass -1 to clear the override and fall back to the global setting', type : 'long', length : 255, required : False}, {name : 'description', description : 'New description for the Instance Boot Group', type : 'string', length : 255, required : False}, {name : 'readinessmaxretryattempts', description : 'Per-boot-group override of the global maximum number of readiness retry attempts. Pass -1 to clear the override and fall back to the global setting', type : 'long', length : 255, required : False}], response : [{name : 'name', description : 'The name of the instance boot group', type : 'string'}, {name : 'accountid', description : 'The account ID owning the instance boot group', type : 'string'}, {name : 'domainpath', description : 'The path of the domain the instance boot group belongs to', type : 'string'}, {name : 'id', description : 'The ID of the instance boot group', type : 'string'}, {name : 'projectid', description : 'The project ID of the instance boot group', type : 'string'}, {name : 'domain', description : 'The domain name of the instance boot group', type : 'string'}, {name : 'account', description : 'The account owning the instance boot group', type : 'string'}, {name : 'created', description : 'The date the instance boot group was created', type : 'date'}, {name : 'readinessmaxretryattempts', description : 'Effective maximum number of readiness retry attempts (per-boot-group override if set, else the global default)', type : 'long'}, {}, {name : 'domainid', description : 'The domain ID of the instance boot group', 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 : 'readinessinitialdelayseconds', description : 'Effective delay in seconds after starting or rebooting an instance before its first readiness check of that attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'project', description : 'The project name of the instance boot group', type : 'string'}, {name : 'description', description : 'The description of the instance boot group', type : 'string'}, {}, {name : 'readinessrebootonretry', description : 'Effective setting for whether an instance is rebooted between readiness retry attempts (per-boot-group override if set, else the global default)', type : 'boolean'}, {name : 'readinessattempttimeoutseconds', description : 'Effective timeout in seconds for each readiness retry attempt (per-boot-group override if set, else the global default)', type : 'long'}], 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 : 'importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume', params : [{name : 'size', description : 'New volume size in GB for the custom disk offering', type : 'long', length : 255, required : False}, {name : 'maxiops', description : 'New maximum number of IOPS for the custom disk offering', type : 'long', 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 : 'shrinkok', description : 'Verify OK to Shrink', type : 'boolean', length : 255, required : False}, {name : 'miniops', description : 'New minimum number of IOPS for the custom disk offering', type : 'long', length : 255, required : False}, {name : 'diskofferingid', description : 'New disk offering ID', type : 'uuid', length : 255, required : True, related : 'createDiskOffering,cloneDiskOffering,listDiskOfferings'}, {name : 'id', description : 'The ID of the volume', type : 'uuid', length : 255, required : True, related : 'importVolume,attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}], response : [{name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {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 : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", 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 : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'vmstate', description : 'State of the Instance', type : 'string'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', 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 : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'kmskeyid', description : 'KMS key 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 : 'name', description : 'Name of the disk volume', 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 : '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 : 'account', description : 'The Account 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 : 'resourcetype', description : 'Resource type', 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 : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', 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 : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'size', description : 'Size of the disk volume', 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 : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', 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 : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'id', description : 'ID of the disk volume', type : 'string'}], httprequesttype : 'POST'}, {name : 'createProjectRole', description : 'Creates a Project role', since : '4.15.0', isasync : False, related : 'listProjectRoles,updateProjectRole', params : [{name : 'name', description : 'Creates a project role with this unique name', type : 'string', length : 255, required : True}, {name : 'description', description : 'The description of the Project role', type : 'string', length : 255, required : False}, {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 : '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'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'name', description : 'The name of the role', type : 'string'}, {}, {}, {name : 'description', description : 'The description 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 : 'createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule', params : [{name : 'endport', description : 'The ending port of Ipv6 firewall rule', type : 'integer', length : 255, required : False}, {name : 'icmpcode', description : 'Error code for this ICMP message', type : 'integer', 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 : '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 : 'icmptype', description : 'Type of the ICMP message being sent', type : 'integer', length : 255, required : False}, {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 : '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 : '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 : 'startport', description : 'The starting 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 : 'privateendport', 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 : 'virtualmachinename', description : 'The Instance name for the port forwarding rule', type : 'string'}, {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 : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {name : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'state', description : 'The state of the rule', 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 : 'virtualmachineid', description : 'The Instance ID 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 : 'domainid', description : 'The ID of 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 : '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 : '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 : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'networkid', description : 'The ID 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'}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {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'}], httprequesttype : 'POST'}, {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 : 'type', description : 'The type of the zone (Public/Private)', type : 'zonetype'}, {name : 'domain', description : 'the name of the domain associated with the DNS zone', type : 'string'}, {name : 'name', description : 'Name of the DNS zone', 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 : '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 : 'networkid', description : 'ID of the network this zone is associated with', type : 'string'}, {name : 'description', description : 'Description for 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 : 'networkname', description : 'Name of the network this zone is associated with', type : 'string'}, {}, {name : 'id', description : 'ID of the DNS zone', type : 'string'}, {name : 'account', description : 'the account associated with the DNS zone', type : 'string'}, {name : 'state', description : 'The state of the zone (Active/Inactive)', type : 'state'}], httprequesttype : 'POST'}, {name : 'listBackups', description : 'Lists Instance backups', since : '4.14.0', isasync : False, related : 'updateBackupSchedule', 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 : 'type', description : 'list backups by type', type : 'string', length : 255, required : False, since : '24.0'}, {name : 'id', description : 'ID of the backup', type : 'uuid', length : 255, required : False, related : 'updateBackupSchedule,listBackups'}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {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 : 'keyword', description : 'List by keyword', 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 : '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 : '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 : 'listvmdetails', description : 'list backups with VM details', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'zoneid', description : 'List backups by zone id', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {name : 'status', description : 'list backups by status', type : 'string', length : 255, required : False, since : '4.23.0'}, {name : 'name', description : 'list backups by name', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'fromcheckpointid', description : 'Previous active checkpoint ID for incremental backups', type : 'string'}, {name : 'validationstatus', description : 'Backup validation status.', type : 'validationstatus'}, {name : 'account', description : 'Account name', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'domain', description : 'Domain name', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {name : 'domainid', description : 'Domain ID', type : 'string'}, {name : 'compressionstatus', description : 'Backup compression status.', type : 'compressionstatus'}, {name : 'backupofferingid', description : 'Backup offering id', type : 'string'}, {name : 'accountid', description : 'Account id', type : 'string'}, {name : 'backupofferingname', description : 'Backup offering name', type : 'string'}, {name : 'hostid', description : 'Host ID where the backup is running', type : 'string'}, {name : 'id', description : 'ID of the Instance backup', type : 'string'}, {name : 'volumes', description : 'Backed up volumes', type : 'string'}, {name : 'virtualsize', description : 'Backup protected (virtual) size in bytes', type : 'long'}, {name : 'type', description : 'Backup type', type : 'string'}, {name : 'uncompressedsize', description : 'Backup uncompressed size in bytes. Only defined if backup is compressed.', type : 'long'}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'externalid', description : 'External backup id', type : 'string'}, {name : 'size', description : 'Backup size in bytes', type : 'long'}, {name : 'status', description : 'Backup status', type : 'status'}, {name : 'isbackupvmexpunged', description : 'Indicates whether the VM from which the backup was taken is expunged or not', type : 'boolean'}, {}, {name : 'vmdetails', description : 'Lists the vm specific details for the backup', type : 'map'}, {name : 'description', description : 'description for the backup', type : 'string'}, {name : 'tocheckpointid', description : 'Next checkpoint ID for incremental backups', type : 'string'}, {name : 'vmbackupofferingremoved', description : 'The backup offering corresponding to this backup was removed from the VM', type : 'boolean'}, {name : 'created', description : 'Backup date', type : 'date'}, {name : 'intervaltype', description : 'Interval type of the backup', type : 'string'}, {name : 'zone', description : 'Zone name', type : 'string'}, {}, {name : 'name', description : 'name of the backup', type : 'string'}], httprequesttype : 'GET'}, {name : 'setupUserTwoFactorAuthentication', description : 'Setup the 2FA for the user.', since : '4.18.0', isasync : False, related : '', params : [{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}, {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'}], response : [{name : 'username', description : 'The user name', type : 'string'}, {}, {name : 'id', description : 'The user ID', type : 'string'}, {name : 'secretcode', description : 'Secret code that needs to be registered with authenticator', 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 : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,listWebhooks,updateWebhook,listWebhookDeliveries,addWebhookFilter'}, {name : 'id', description : 'The ID of the Webhook filter', type : 'uuid', length : 255, required : False, related : 'listWebhookFilters'}], 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 : 'createDnsZone', description : 'Creates a new DNS Zone on a specific server', since : '4.23.0', isasync : True, related : 'listDnsZones', params : [{name : 'name', description : 'The name of the DNS zone (e.g. example.com)', type : 'string', length : 255, required : True}, {name : 'type', description : 'The type of zone (Public, Private). Defaults to Public.', type : 'string', length : 255, required : False}, {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}, {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'}], response : [{name : 'type', description : 'The type of the zone (Public/Private)', type : 'zonetype'}, {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 : 'dnsserveraccount', description : 'the account name of the DNS server owner', 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 zone (Active/Inactive)', type : 'state'}, {name : 'dnsserverid', description : 'ID of the DNS server this zone belongs to', type : 'string'}, {name : 'domain', description : 'the name of the domain associated with the DNS zone', type : 'string'}, {name : 'name', description : 'Name of the DNS zone', type : 'string'}, {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 : 'dnsservername', description : 'the name of the DNS server hosting this zone', type : 'string'}, {name : 'description', description : 'Description for the DNS zone', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the DNS server', type : 'string'}, {name : 'account', description : 'the account associated with 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 : '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 : 'listWebhooks', description : 'Lists Webhooks', since : '4.20.0', isasync : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries,addWebhookFilter', params : [{name : 'state', description : 'The state of the Webhook', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'scope', description : 'The scope of the Webhook', type : 'string', length : 255, required : False}, {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 : '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 Webhook', 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 : 'id', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,listWebhooks,updateWebhook,listWebhookDeliveries,addWebhookFilter'}, {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,moveDomain'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}], response : [{name : 'projectid', description : 'the project id of the Kubernetes cluster', type : 'string'}, {}, {name : 'account', description : 'The account associated with the Webhook', 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 : 'name', description : 'The name 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 : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'description', description : 'The description of 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', type : 'string'}, {name : 'created', description : 'The date when this Webhook was created', type : 'date'}, {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 : '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 : 'pagesize', description : '', type : 'integer', 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 : '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'}], response : [{name : 'name', description : 'the name of the VM', type : 'string'}, {name : 'id', description : 'the ID of the VM', type : 'string'}, {name : 'clustername', description : 'the cluster name for the VM', type : 'string'}, {name : 'clusterid', description : 'the cluster ID for the VM', type : 'string'}, {name : 'hostname', description : 'the hostname for the VM', 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 : 'hostid', description : 'the host ID for 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 : 'payloadurl', description : 'Payload URL of the Webhook delivery', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the Webhook delivery for redelivery', type : 'uuid', length : 255, required : False, related : 'executeWebhookDelivery'}, {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 : '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 : 'payload', description : 'Payload of the Webhook delivery', type : 'string', length : 255, required : False}], response : [{name : 'headers', description : 'The headers of the webhook delivery', type : 'string'}, {name : 'startdate', description : 'The start time of the Webhook delivery', type : 'date'}, {name : 'enddate', description : 'The end time of the Webhook delivery', type : 'date'}, {name : 'response', description : 'The response of the webhook delivery', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', 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 : 'eventtype', description : 'The type of the event', type : 'string'}, {}, {}, {name : 'payload', description : 'The payload of the webhook delivery', type : 'string'}, {name : 'managementserverid', description : 'The ID of the management server which executed delivery', type : 'string'}, {name : 'webhookname', description : 'The name of the Webhook', type : 'string'}, {name : 'success', description : 'Whether Webhook delivery succeeded or not', type : 'boolean'}, {name : 'id', description : 'The ID of the Webhook delivery', type : 'string'}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'updateAutoScaleVmGroup', description : 'Updates an existing autoscale Instance group.', isasync : True, related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups', params : [{name : 'name', description : 'The name of the autoscale vmgroup', type : 'string', length : 255, required : False, since : '4.18.0'}, {name : 'id', description : 'The ID of the autoscale group', type : 'uuid', length : 255, required : True, related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup'}, {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 : 'scaleuppolicyids', description : 'List of scaleup 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 : 'scaledownpolicyids', description : 'List of scaledown autoscale policies', type : 'list', length : 255, required : False, related : 'listAutoScalePolicies,updateAutoScalePolicy'}, {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'}], response : [{name : 'project', description : 'The project name of the Instance group', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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 : 'lbprovider', description : 'The LB provider of the guest Network the LB rule belongs to', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {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 : 'created', description : 'The date when this Instance group was created', type : 'date'}, {name : 'privateport', description : 'The private port', 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 : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {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 : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {name : 'state', description : 'The current state of the AutoScale Instance Group', type : 'string'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'projectid', description : 'The project id of the Instance group', type : 'string'}, {name : 'publicport', description : 'The public 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 : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {name : 'associatednetworkid', description : 'The id 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'}], 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 : '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 : 'serviceofferingid', description : 'List by the service offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'arch', description : 'CPU arch of the 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, related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}, {name : 'keyword', description : 'List by keyword', type : 'string', 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 : 'page', description : '', type : 'integer', 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 : 'createExtension,listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension'}, {name : 'podid', description : 'The pod ID', type : 'uuid', length : 255, required : False, related : 'createPod,listPods,updatePod,createManagementNetworkIpRange'}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", type : 'boolean', 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 : 'keypair', description : 'List Instances by SSH keypair name', type : 'string', 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 : '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 : 'userdataid', description : 'the instances by userdata', type : 'uuid', length : 255, required : False, since : '4.20.1', related : 'listCniConfiguration'}, {name : 'hostid', description : 'The host ID', type : 'uuid', length : 255, required : False, related : 'addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost'}, {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 : 'forvirtualnetwork', description : 'List by Network type; true if need to list Instances using Virtual Network, false otherwise', type : 'boolean', length : 255, required : False}, {name : 'groupid', description : 'The group ID', type : 'uuid', length : 255, required : False, related : 'createInstanceGroup,updateInstanceGroup'}, {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 : 'showicon', description : 'Flag to display the resource icon for Instances', type : 'boolean', length : 255, required : False, since : '4.16.0.0'}, {name : 'affinitygroupid', description : 'List Instances by affinity group', type : 'uuid', length : 255, required : False, related : 'createAffinityGroup,listAffinityGroups'}, {name : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks'}, {name : 'hypervisor', description : 'The target hypervisor for the Template', 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 : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', 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 : '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 : 'vpcid', description : 'List Instances by VPC', type : 'uuid', length : 255, required : False, related : 'listVPCs,createVPC,listVPCs,updateVPC,migrateVPC'}, {name : 'isoid', description : 'List Instances by ISO', type : 'uuid', 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 : '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 : '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 : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'createZone,updateZone,listZones,listZones'}, {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 : '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 : '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 : 'backupofferingid', description : 'List by the backup offering', type : 'uuid', length : 255, required : False, since : '4.17', related : 'listBackupProviderOfferings,importBackupOffering,cloneBackupOffering,listBackupOfferings,updateBackupOffering,createBackupOffering'}, {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 : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', 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 : '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'}], response : [{name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'groupid', description : 'The group ID of 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 : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'zoneid', description : 'The ID 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 : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'isolationuri', description : 'The isolation URI of the NIC', 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 : '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 : 'id', description : 'The ID of the NIC', type : 'string'}, {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 : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', 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 : 'gateway', description : 'The gateway of the NIC', 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 : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', 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 : '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 : 'type', description : 'The type of the NIC', type : 'string'}, {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 : 'isdefault', description : 'True if NIC is default, false otherwise', 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 : 'projectid', description : 'The project ID 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 : 'domainpath', description : 'Path of the domain in which the virtual machine exists', 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 : 'arch', description : 'CPU arch of the VM', type : 'string'}, {}, {name : 'hostid', description : 'The ID of the host 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 : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {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 : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', 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 : '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 : '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 : '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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', 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 : 'key', description : 'Tag key name', 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 : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}]}, {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 : '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 : 'ruleid', description : 'The ID 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 : '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 : '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 : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', 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 : '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 : '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 : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'name', description : 'The name of the security group', 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 : '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 : '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 : 'projectid', description : 'The project ID the 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 : 'domainid', description : 'The ID 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 : 'resourceid', description : 'ID of the resource', 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 : 'account', description : 'The Account owning 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 : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {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 : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'domain', description : 'The name 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 : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering 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 : '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 : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile 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 : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {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 : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'state', description : 'The state of the Instance', 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 : 'virtualmachineIds', description : 'Instance IDs 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 : 'id', description : 'The ID of 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 : 'account', description : 'The account owning 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 : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}]}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {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 : '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 : '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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', 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 : 'value', description : 'Tag value', type : 'string'}]}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', 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 : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read 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 : '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 : '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 : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {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 : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {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 : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'userid', description : "The User's ID who deployed 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'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}], httprequesttype : 'GET'}, {name : 'listInstanceBootGroups', description : 'Lists Instance Boot Groups', since : '24.0', isasync : False, related : 'createInstanceBootGroup,startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup', params : [{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 : '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 : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'instancegroupid', description : 'List Instance Boot Groups that contain the Instance Group', type : 'uuid', length : 255, required : False, related : 'createInstanceGroup,updateInstanceGroup'}, {name : 'virtualmachineid', description : 'List Instance Boot Groups that contain the Instance', type : 'uuid', length : 255, required : 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'}, {name : 'keyword', description : 'List Instance Boot Groups by name keyword', 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 : '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 : 'id', description : 'List Instance Boot Group by ID', type : 'uuid', length : 255, required : False, related : 'createInstanceBootGroup,listInstanceBootGroups,startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup'}], response : [{name : 'domain', description : 'The domain name of the instance boot group', type : 'string'}, {name : 'name', description : 'The name of the instance boot group', type : 'string'}, {name : 'id', description : 'The ID of the instance boot group', type : 'string'}, {name : 'accountid', description : 'The account ID owning the instance boot group', type : 'string'}, {}, {name : 'projectid', description : 'The project ID of the instance boot group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the instance boot group', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'readinessrebootonretry', description : 'Effective setting for whether an instance is rebooted between readiness retry attempts (per-boot-group override if set, else the global default)', type : 'boolean'}, {name : 'project', description : 'The project name of the instance boot group', type : 'string'}, {name : 'created', description : 'The date the instance boot group was created', type : 'date'}, {name : 'account', description : 'The account owning the instance boot group', type : 'string'}, {}, {name : 'domainpath', description : 'The path of the domain the instance boot group belongs to', type : 'string'}, {name : 'description', description : 'The description of the instance boot group', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'readinessinitialdelayseconds', description : 'Effective delay in seconds after starting or rebooting an instance before its first readiness check of that attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'readinessattempttimeoutseconds', description : 'Effective timeout in seconds for each readiness retry attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'readinessmaxretryattempts', description : 'Effective maximum number of readiness retry attempts (per-boot-group override if set, else the global default)', type : 'long'}], 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 : '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 : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'zonename', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {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 : '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 : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'memory', description : 'The memory 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 : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'state', description : 'The state of the Kubernetes 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 : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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 : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'maxsize', description : 'Maximum size of the cluster', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {}, {name : 'workerofferingname', description : 'the name of the service offering of the worker 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 : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'name', description : 'The name 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 : '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 : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', 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 : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}], 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 : 'created', description : 'The date when this Instance was created', type : 'date'}, {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 : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {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 : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', 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 : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', 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 : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', 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 : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'netmask', description : 'The netmask of the NIC', 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 : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', 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 : '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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {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 : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {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 : '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 : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {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 : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', 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 : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', 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 : 'name', description : 'The name of the attached ISO', type : 'string'}, {name : 'displaytext', description : 'The display text of the attached ISO', type : 'string'}]}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{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 : 'resourcetype', description : 'Resource type', 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 : '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 : 'domain', description : 'The domain associated with the tag', type : 'string'}]}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', 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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', 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 : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance 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 : 'deleteprotection', description : 'true if vm has delete protection.', 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 : 'description', description : 'The description of the affinity group', type : 'string'}, {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 : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'account', description : 'The account owning 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 : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}]}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {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 : 'protocol', description : 'The protocol of the security group rule', 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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'value', description : 'Tag value', 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 : 'key', description : 'Tag key name', 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 : 'account', description : 'The Account 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 : 'endport', description : 'The ending IP of the security group rule ', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', 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 : 'icmptype', description : 'The type of the ICMP message response', 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 : '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 : '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 : '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 : 'customer', description : 'Customer associated with the tag', type : 'string'}, {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 : '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 : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'description', description : 'The description of the security group', type : 'string'}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', type : 'string'}, {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 : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'securitygroupname', description : 'Security group name', 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 : '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 : '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 : '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 : '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 : '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 : 'value', description : 'Tag value', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}]}, {name : 'project', description : 'The project name of the group', type : 'string'}]}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', 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 : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {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 : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {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 : '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 : '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 : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'password', description : 'The password (if exists) of the Instance', 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 : '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 : '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 : 'webhookid', description : 'ID for the Webhook', type : 'uuid', length : 255, required : True, related : 'createWebhook,updateWebhook,listWebhookDeliveries,addWebhookFilter'}, {name : 'matchtype', description : 'Match type for the Webhook filter - Exact, Prefix, Suffix or Contains', type : 'string', length : 255, required : False}, {name : 'value', description : 'Value for the Webhook which that will be matched', 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 : '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 : 'domain', description : 'The name of the domain in which the Webhook exists', 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 : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {name : 'projectid', description : 'the project id of the Kubernetes cluster', type : 'string'}, {name : 'secretkey', description : 'The secret key for the Webhook', type : 'string'}, {}, {name : 'domainid', description : 'The ID of the domain in which the Webhook exists', type : 'string'}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {}, {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 : 'created', description : 'The date when this Webhook was created', type : 'date'}, {name : 'description', description : 'The description of the Webhook', type : 'string'}, {name : 'id', description : 'The ID of the Webhook', type : 'string'}], 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 : 'name', description : 'the name of the protocol parameter', type : 'string'}, {name : 'details', description : 'the details of the protocol parameter', type : 'map'}, {}, {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 : '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'}], httprequesttype : 'GET'}, {name : 'listGuiThemes', description : 'Lists GUI themes.', since : '4.21.0.0', isasync : False, related : 'createGuiTheme', params : [{name : 'name', description : 'The name of the theme.', type : 'string', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'listall', description : 'Whether to list all 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 : 'page', description : '', type : 'integer', 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 : 'pagesize', 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 : 'showremoved', description : 'Whether to list removed themes.', type : 'boolean', length : 255, required : False}, {name : 'listonlydefaulttheme', description : 'Whether to only list the default theme.', type : 'boolean', length : 255, required : False}], response : [{name : 'id', description : 'ID of the custom GUI theme.', type : 'string'}, {}, {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'}, {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 : '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 : '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 : 'description', description : 'Description of the GUI theme.', type : 'string'}, {name : 'name', description : 'Name of the GUI 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 : '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 : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {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 : 'removed', description : 'When the GUI theme was removed.', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'recursivedomains', description : 'Whether to consider the subdomains of the informed domain IDs.', 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 : 'account', description : 'An optional account for the userdata. Must be used with domainId.', type : 'string', length : 255, required : False}, {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 : 'projectid', description : 'An optional project for the userdata', type : 'uuid', length : 255, required : False, related : 'activateProject,createProject,suspendProject,updateProject'}], 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 : 'updateInstanceBootGroupMember', description : 'Updates the boot order of a member in an instance boot group', since : '24.0', isasync : False, related : 'addMemberToInstanceBootGroup,listInstanceBootGroupMembers', params : [{name : 'order', description : 'The new boot order value (0 or greater)', type : 'integer', length : 255, required : True}, {name : 'id', description : 'The ID of the boot group member entry', type : 'uuid', length : 255, required : True, related : 'addMemberToInstanceBootGroup,updateInstanceBootGroupMember,listInstanceBootGroupMembers'}], response : [{name : 'order', description : 'The boot order value for this member', type : 'int'}, {name : 'memberid', description : 'The ID of the VM or InstanceGroup', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'membername', description : 'The name of the VM or InstanceGroup', type : 'string'}, {name : 'created', description : 'The date the member was added to the boot group', type : 'date'}, {name : 'readinessmessage', description : "Why readinessstatus is what it is: the failing rule(s)' cached message, and/or a count of not-ready member VMs for InstanceGroup members", type : 'string'}, {name : 'readinessstatus', description : 'The last cached readiness evaluation', type : 'string'}, {}, {name : 'id', description : 'The UUID of this member entry', type : 'string'}, {name : 'bootgroupid', description : 'The ID of the boot group this member belongs to', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'memberstate', description : 'The state of the Instance', type : 'string'}, {name : 'membertype', description : 'The type of the member: VirtualMachine or InstanceGroup', type : 'string'}, {name : 'readinessmode', description : 'None, CHILD_DEPENDENT or RULE_BASED, computed from whether readiness rules are attached', type : 'string'}, {name : 'children', description : 'For InstanceGroup members, the VMs within the group (only present when requested via details=children)', type : 'list'}], httprequesttype : 'POST'}, {name : 'listVmwareDcs', description : 'Retrieves VMware DC(s) associated with a zone.', isasync : False, related : 'addVmwareDc', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {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 : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'vcenter', description : 'The VMware vCenter name/ip', type : 'string'}, {name : 'id', description : 'The VMware Datacenter ID', type : 'string'}, {name : 'name', description : 'The VMware Datacenter name', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'zoneid', description : 'The Zone ID associated with this VMware Datacenter', type : 'long'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'deleteBackupSchedule', description : 'Deletes the backup schedule of a Instance', since : '4.14.0', isasync : False, params : [{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'}, {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'}], 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 : 'listResourceSchedule', description : 'List Resource Schedules', since : '4.23.0', isasync : False, related : 'updateResourceSchedule', params : [{name : 'action', description : 'Action to take on the resource.', type : 'string', length : 255, required : False}, {name : 'enabled', description : 'Filter by enabled status.', type : 'boolean', length : 255, required : False}, {name : 'resourcetype', description : 'Type of the resource.', type : 'string', length : 255, required : True}, {name : 'resourceid', description : 'ID of the resource for which schedules are to be listed.', 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 : '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 : 'id', description : 'ID of the schedule', type : 'uuid', length : 255, required : False, related : 'listResourceSchedule,updateResourceSchedule'}], response : [{name : 'schedule', description : 'Cron formatted resource schedule', type : 'string'}, {name : 'enabled', description : 'Resource schedule is enabled', type : 'boolean'}, {name : 'id', description : 'The ID of resource schedule', type : 'string'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'description', description : 'Description of resource schedule', type : 'string'}, {name : 'action', description : 'Action', type : 'action'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'resourcetype', description : 'Type of the resource', type : 'apicommandresourcetype'}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {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 : 'details', description : 'Schedule details', type : 'map'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}], httprequesttype : 'GET'}, {name : 'listVolumesUsageHistory', description : 'Lists volume stats', since : '4.18.0', isasync : False, related : '', params : [{name : 'pagesize', description : '', type : 'integer', 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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the volume.', type : 'uuid', length : 255, required : False, related : 'importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}, {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 : 'ids', description : 'the IDs of the Volumes, mutually exclusive with id.', type : 'list', length : 255, required : False, related : 'importVolume,createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}, {name : 'startdate', description : 'Start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}], response : [{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'}, {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 : 'id', description : 'The ID of the volume', type : 'string'}, {}], httprequesttype : 'GET'}, {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 : '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 : 'createProjectRolePermission', description : 'Adds API permissions to a project role', since : '4.15.0', isasync : False, related : 'listProjectRolePermissions', params : [{name : 'description', description : 'The description of the role permission', type : 'string', length : 255, required : False}, {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 : 'projectid', description : 'ID of project where project role permission is to be created', 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'}], response : [{name : 'rule', description : 'The api name or wildcard rule', type : 'string'}, {name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'description', description : 'The description of the role permission', type : 'string'}, {name : 'id', description : 'The ID of the project role permission', 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 : 'permission', description : 'The permission type of the api name or wildcard rule, allow/deny', type : 'string'}, {name : 'projectroleid', description : 'The ID of the project role to which the role permission belongs', type : 'string'}, {name : 'projectrolename', description : 'The name of the project role to which the role permission belongs', type : 'string'}, {}, {}], httprequesttype : 'POST'}, {name : 'createConsoleEndpoint', description : 'Create a console endpoint to connect to a Instance console', since : '4.18.0', isasync : False, related : '', params : [{name : 'token', description : '(optional) extra security token, valid when the extra validation is enabled', type : 'string', length : 255, required : False}, {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'}], 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 : 'websocket', description : 'The console websocket options', type : 'consoleendpointwebsocketresponse'}, {name : 'details', description : 'Details in case of an error', type : 'string'}, {}, {name : 'url', description : 'The console url', type : 'string'}, {}, {name : 'success', description : 'True if the console endpoint is generated properly', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'updateProjectRolePermission', description : 'Updates a project role permission and/or order', since : '4.15.0', isasync : False, params : [{name : 'permission', description : 'Rule permission, can be: allow or deny', type : 'string', length : 255, required : False}, {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 : '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'}], 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 : 'addUserToProject', description : 'Adds User to a project', since : '4.14', isasync : True, params : [{name : 'projectroleid', description : 'ID of the project role', type : 'uuid', length : 255, required : False, related : 'listProjectRoles,updateProjectRole'}, {name : 'roletype', description : 'Project role type to be assigned to the User - Admin/Regular', 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 : 'username', description : 'Name of the User to be added to the project', type : 'string', length : 255, required : True}, {name : 'email', description : 'Email ID of User to which invitation to the project is going to be sent', type : 'string', 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 : '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 : '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 : '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 : 'listWebhookFilters', description : 'Lists Webhook filters', since : '4.23.0', isasync : False, related : '', params : [{name : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries'}, {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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', 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 : '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 : 'type', description : 'The type of the Webhook filter', type : 'string'}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'string'}, {name : 'mode', description : 'The type of the Webhook filter', type : 'string'}, {name : 'webhookname', description : 'The name of the Webhook', type : 'string'}, {name : 'matchtype', description : 'The type of the Webhook filter', type : 'string'}, {}, {name : 'value', description : 'The type of the Webhook filter', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateCondition', description : 'Updates a condition for Instance auto scaling', since : '4.18.0', isasync : True, params : [{name : 'threshold', description : 'Value for which the Counter will be evaluated with the Operator selected.', type : 'long', length : 255, required : True}, {name : 'id', description : 'The ID of the condition.', type : 'uuid', length : 255, required : True, related : 'listConditions'}, {name : 'relationaloperator', description : 'Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.', 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 : '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 : 'cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost'}, {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'}, {name : 'virtualmachineid', description : 'The ID of the Instance', type : 'uuid', length : 255, required : True, related : 'migrateSystemVm,startSystemVm,changeServiceForSystemVm'}, {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'}], response : [{name : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'isdynamicallyscalable', description : 'True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'version', description : 'The systemvm agent version', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'name', description : 'The name of the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', 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 : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', 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 : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {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 : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'activeviewersessions', description : 'The number of active console sessions for the console proxy System VM', type : 'integer'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'POST'}, {name : 'deleteInstanceBootGroupReadinessRule', description : 'Deletes an Instance Boot Group readiness rule', since : '24.0', isasync : False, params : [{name : 'id', description : 'The ID of the Instance Boot Group readiness rule', type : 'uuid', length : 255, required : True, related : 'createInstanceBootGroupReadinessRule,updateInstanceBootGroupReadinessRule'}], 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 : 'createRoutingFirewallRule', description : 'Creates a routing firewall rule in the given network in ROUTED mode', since : '4.20.0', isasync : True, related : 'listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule', params : [{name : 'endport', description : 'the ending 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 : '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 : '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}, {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 : '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 : 'fordisplay', description : 'an optional field, whether to the display the rule to the end user or not', type : 'boolean', length : 255, required : False}, {name : 'startport', description : 'the starting port of firewall rule', type : 'integer', length : 255, required : False}], response : [{name : 'ipaddress', description : 'The public IP address for the port forwarding rule', type : 'string'}, {name : 'id', description : 'The ID of the port forwarding rule', 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 : '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 : 'domainpath', description : 'Path 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 : '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 : '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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}]}, {}, {name : 'privateport', description : "The starting port of port forwarding rule's private port range", 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 : 'virtualmachineid', description : 'The Instance ID for the port forwarding rule', type : 'string'}, {name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name 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 : '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 : 'virtualmachinedisplayname', description : 'The Instance display name 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 : 'publicport', description : "The starting port of port forwarding rule's public 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'}], 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'accountid', description : 'The ID of Account the Network is available for', type : 'string'}, {name : 'projectid', description : 'The ID of project the Network is available for', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'networkid', description : 'The Network ID', type : 'string'}, {name : 'domain', description : 'The name of the domain to which the Network belongs', type : 'string'}, {}, {name : 'domainid', description : 'The ID of the domain to which the Network belongs', type : 'string'}, {name : 'account', description : 'The Account the Network is available for', type : 'string'}, {name : 'project', description : 'The project the Network is available for', type : 'string'}], 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 : '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 : 'updateResourceSchedule', description : 'Update Resource Schedule', since : '4.23.0', isasync : False, related : '', params : [{name : 'description', description : 'Description of the schedule', type : 'string', length : 255, required : False}, {name : 'id', description : 'ID of the schedule to be updated', type : 'uuid', length : 255, required : True, related : 'updateResourceSchedule'}, {name : 'enddate', description : 'End date after which the schedule becomes inactive.', type : 'date', length : 255, required : False}, {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 : 'startdate', description : 'Start date from which the schedule becomes active.', type : 'date', 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}], response : [{name : 'resourceid', description : 'ID of the resource', type : 'string'}, {}, {}, {name : 'enabled', description : 'Resource schedule is enabled', type : 'boolean'}, {name : 'details', description : 'Schedule details', type : 'map'}, {name : 'action', description : 'Action', type : 'action'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'description', description : 'Description of resource schedule', type : 'string'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {name : 'id', description : 'The ID of resource schedule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'resourcetype', description : 'Type of the resource', type : 'apicommandresourcetype'}, {name : 'timezone', description : 'Timezone of the schedule', type : 'string'}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'schedule', description : 'Cron formatted resource schedule', type : 'string'}], httprequesttype : 'POST'}, {name : 'startVmwareCbtMigration', description : 'Start tracking a VMware CBT based migration session', since : '4.24.0', isasync : True, related : 'listVmwareCbtMigrations,syncVmwareCbtMigration,cutoverVmwareCbtMigration,cancelVmwareCbtMigration', params : [{name : 'clustername', description : 'the source VMware cluster name', type : 'string', length : 255, required : False}, {name : 'serviceofferingid', description : 'the service offering for the migrated VM', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'displayname', description : 'the display name of the migrated VM', type : 'string', length : 255, required : False}, {name : 'forced', description : 'import despite duplicate NIC MAC addresses; CloudStack generates a new MAC address when a duplicate exists', type : 'boolean', length : 255, required : False}, {name : 'domainid', description : 'import the migrated VM to the specified domain', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'projectid', description : 'import the migrated VM for the project', type : 'uuid', length : 255, required : False, related : 'activateProject,createProject,suspendProject'}, {name : 'existingvcenterid', description : 'UUID of a linked existing vCenter', type : 'uuid', length : 255, required : False, related : 'addVmwareDc'}, {name : 'hostname', description : 'the host name of the migrated VM', type : 'string', length : 255, required : False}, {name : 'convertinstancepoolid', description : 'optional primary storage pool for converted disks', type : 'uuid', length : 255, required : False, related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities'}, {name : 'nicipaddresslist', description : 'VM NIC to ip address mapping using keys NIC, ip4Address', type : 'map', length : 255, required : False}, {name : 'zoneid', description : 'the destination zone ID', type : 'uuid', length : 255, required : True, related : 'createZone,listZones'}, {name : 'details', description : 'optional migration details, including VDDK settings such as vddk.lib.dir, vddk.transports and vddk.thumbprint', type : 'map', length : 255, required : False}, {name : 'datadiskofferinglist', description : 'datadisk to disk-offering mapping using keys disk and diskOffering', type : 'map', length : 255, required : False}, {name : 'convertinstancehostid', description : 'optional KVM host to perform virt-v2v conversion and CBT block replication', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost'}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'uuid', length : 255, required : True, related : 'addCluster,updateCluster'}, {name : 'nicnetworklist', description : 'VM NIC to network id mapping using keys NIC and network', type : 'map', length : 255, required : False}, {name : 'password', description : 'the password for the source vCenter', type : 'string', length : 255, required : False}, {name : 'hostip', description : 'the source VMware ESXi host IP address or FQDN', type : 'string', length : 255, required : False}, {name : 'vcenter', description : 'the source vCenter IP address or FQDN', type : 'string', length : 255, required : False}, {name : 'username', description : 'the username for the source vCenter', type : 'string', length : 255, required : False}, {name : 'datacentername', description : 'the source VMware datacenter name', type : 'string', length : 255, required : False}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string', length : 255, required : True}, {name : 'account', description : 'optional account for the migrated VM. Must be used with domainid', type : 'string', length : 255, required : False}, {name : 'osid', description : 'optional guest OS ID for the migrated VM', type : 'uuid', length : 255, required : False, related : 'addGuestOs'}, {name : 'templateid', description : 'the template ID for the migrated VM', 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'}], response : [{name : 'completedcycles', description : 'the number of completed CBT delta cycles', type : 'int'}, {name : 'cycle', description : 'the CBT delta synchronization cycles tracked by this VMware CBT migration', type : 'list'}, {name : 'zoneid', description : 'the destination zone ID', type : 'string'}, {name : 'zonename', description : 'the destination zone name', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'virtualmachineid', description : 'the ID of the imported VM after cutover', type : 'string'}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string'}, {name : 'convertinstancehostname', description : 'the KVM host name selected for conversion and CBT replication', type : 'string'}, {name : 'displayname', description : 'the display name of the target VM', type : 'string'}, {name : 'poolname', description : 'the storage pool name selected for converted disks', type : 'string'}, {name : 'accountid', description : 'the account ID', type : 'string'}, {name : 'convertinstancehostid', description : 'the KVM host selected for conversion and CBT replication', type : 'string'}, {}, {name : 'sourcehost', description : 'the source VMware ESXi host', type : 'string'}, {name : 'lasterror', description : 'the last migration error', type : 'string'}, {name : 'lastupdated', description : 'the last updated date of the VMware CBT migration', type : 'date'}, {name : 'quietcycles', description : 'the number of consecutive quiet CBT delta cycles', type : 'int'}, {name : 'vcenter', description : 'the source VMware vCenter', type : 'string'}, {name : 'state', description : 'the migration state', type : 'string'}, {name : 'currentstepduration', description : 'the elapsed time spent in the current migration step', type : 'string'}, {name : 'created', description : 'the create date of the VMware CBT migration', type : 'date'}, {name : 'existingvcenterid', description : 'the linked existing vCenter ID, when used', type : 'string'}, {name : 'currentstep', description : 'the current migration step', type : 'string'}, {name : 'lastdirtyrate', description : 'the dirty rate in bytes per second observed in the last CBT delta cycle', type : 'long'}, {name : 'convertinstancepoolid', description : 'the storage pool selected for converted disks', type : 'string'}, {name : 'id', description : 'the ID of the VMware CBT migration', type : 'string'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'clustername', description : 'the destination KVM cluster name', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'datacentername', description : 'the source VMware datacenter', type : 'string'}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'string'}, {name : 'sourcecluster', description : 'the source VMware cluster', type : 'string'}, {name : 'disk', description : 'the source and target disks tracked by this VMware CBT migration', type : 'list'}, {}, {name : 'lastchangedbytes', description : 'the changed bytes observed in the last CBT delta cycle', type : 'long'}, {name : 'totalchangedbytes', description : 'the total changed bytes synchronized across CBT delta cycles', type : 'long'}], httprequesttype : 'POST'}, {name : 'listWebhookDeliveries', description : 'Lists Webhook deliveries', since : '4.20.0', isasync : False, related : 'createWebhook,updateWebhook', 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 listed.', type : 'date', length : 255, required : False}, {name : 'eventtype', description : 'The event type of the Webhook delivery', type : 'string', length : 255, required : False}, {name : 'managementserverid', description : 'The ID of the management server', type : 'uuid', length : 255, required : False, related : 'listManagementServers'}, {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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'webhookid', description : 'The ID of the Webhook', type : 'uuid', length : 255, required : False, related : 'createWebhook,updateWebhook,listWebhookDeliveries'}, {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 : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'created', description : 'The date when this Webhook was created', type : 'date'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'projectid', description : 'the project id of the Kubernetes cluster', 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {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 : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}, {name : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {name : 'id', description : 'The ID 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 : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {name : 'description', description : 'The description of the Webhook', type : 'string'}], httprequesttype : 'GET'}, {name : 'createInstanceBootGroup', description : 'Creates an Instance Boot Group', since : '24.0', isasync : False, related : 'startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup', params : [{name : 'readinessinitialdelayseconds', description : 'Per-boot-group override of the global delay (seconds) after starting or rebooting an instance before its first readiness check of that attempt', type : 'long', length : 255, required : False}, {name : 'projectid', description : 'The project of the Instance Boot Group', type : 'uuid', length : 255, required : False, related : 'activateProject,createProject,suspendProject'}, {name : 'readinessattempttimeoutseconds', description : 'Per-boot-group override of the global timeout (seconds) for each readiness retry attempt', type : 'long', length : 255, required : False}, {name : 'name', description : 'The name of the Instance Boot Group', type : 'string', length : 255, required : True}, {name : 'description', description : 'The description of the Instance Boot Group', type : 'string', length : 255, required : False}, {name : 'account', description : 'The account of the Instance Boot Group. Must be used with domainid', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'The domain ID of the account owning the Instance Boot Group', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomainChildren,listDomains,listDomains,moveDomain'}, {name : 'readinessrebootonretry', description : 'Per-boot-group override of whether an instance is rebooted between readiness retry attempts', type : 'boolean', length : 255, required : False}, {name : 'readinessmaxretryattempts', description : 'Per-boot-group override of the global maximum number of readiness retry attempts', type : 'long', length : 255, required : False}], response : [{name : 'account', description : 'The account owning the instance boot group', type : 'string'}, {name : 'readinessmaxretryattempts', description : 'Effective maximum number of readiness retry attempts (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'domainpath', description : 'The path of the domain the instance boot group belongs to', type : 'string'}, {name : 'name', description : 'The name of the instance boot group', 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 ID of the instance boot group', type : 'string'}, {name : 'readinessinitialdelayseconds', description : 'Effective delay in seconds after starting or rebooting an instance before its first readiness check of that attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'project', description : 'The project name of the instance boot group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the instance boot group', type : 'string'}, {name : 'accountid', description : 'The account ID owning the instance boot group', type : 'string'}, {name : 'created', description : 'The date the instance boot group was created', type : 'date'}, {}, {name : 'readinessrebootonretry', description : 'Effective setting for whether an instance is rebooted between readiness retry attempts (per-boot-group override if set, else the global default)', type : 'boolean'}, {}, {name : 'description', description : 'The description of the instance boot group', type : 'string'}, {name : 'readinessattempttimeoutseconds', description : 'Effective timeout in seconds for each readiness retry attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'projectid', description : 'The project ID of the instance boot group', type : 'string'}, {name : 'domain', description : 'The domain name of the instance boot group', type : 'string'}], httprequesttype : 'POST'}, {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 : '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 : 'addVmwareDc', description : 'Adds a VMware datacenter to specified zone', isasync : False, related : '', params : [{name : 'username', description : 'The Username required to connect to resource.', type : 'string', length : 255, required : False}, {name : 'name', description : 'Name of VMware datacenter to be added to specified zone.', type : 'string', length : 255, required : True}, {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 : 'password', description : 'The password for specified username.', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'The Zone ID.', type : 'uuid', length : 255, required : True, related : 'createZone,listZones'}], response : [{name : 'id', description : 'The VMware Datacenter ID', type : 'string'}, {name : 'name', description : 'The VMware Datacenter name', type : 'string'}, {}, {name : 'zoneid', description : 'The Zone ID associated with this VMware Datacenter', type : 'long'}, {name : 'vcenter', description : 'The VMware vCenter name/ip', 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 : 'updateIpv6FirewallRule', description : 'Updates Ipv6 firewall rule with specified ID', isasync : True, related : 'listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule', params : [{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}, {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 : '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 Ipv6 firewall rule to the end User or not', type : 'boolean', length : 255, required : False, since : '4.4'}, {name : 'icmpcode', description : 'Error code for this ICMP message', type : 'integer', length : 255, required : False}, {name : 'id', description : 'The ID of the IPv6 firewall rule', type : 'uuid', length : 255, required : True, related : 'listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule'}, {name : 'icmptype', description : 'Type of the ICMP message being sent', type : 'integer', length : 255, required : False}, {name : 'endport', description : 'The ending port of Ipv6 firewall rule', type : 'integer', length : 255, required : False}, {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 : 'startport', description : 'The starting 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 : 'publicport', description : "The starting port of port forwarding rule's public 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 : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'key', description : 'Tag key name', 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 : '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 : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {}, {name : 'protocol', description : 'The protocol of the port forwarding rule', type : 'string'}, {name : 'virtualmachinedisplayname', description : 'The Instance display name for the port forwarding rule', type : 'string'}, {name : 'privateendport', 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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 : '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 : '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 : 'networkname', description : 'The Name 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 : 'ipaddressid', description : 'The public IP address id for the port forwarding rule', type : 'string'}, {name : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name for 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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'}], httprequesttype : 'GET'}, {name : 'removeInstanceBootGroupMember', description : 'Removes a member from an Instance Boot Group', since : '24.0', isasync : False, params : [{name : 'id', description : 'The ID of the Instance Boot Group member to remove', type : 'uuid', length : 255, required : True, related : 'addMemberToInstanceBootGroup,listInstanceBootGroupMembers'}], 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 : 'listAutoScaleVmGroups', description : 'Lists autoscale Instance groups.', isasync : False, related : 'enableAutoScaleVmGroup', 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 : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', 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 : 'policyid', description : 'The ID of the policy', type : 'uuid', length : 255, required : False, related : 'listAutoScalePolicies'}, {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 : 'activateProject,createProject'}, {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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'id', description : 'The ID of the autoscale Instance group', type : 'uuid', length : 255, required : False, related : 'enableAutoScaleVmGroup,listAutoScaleVmGroups'}, {name : 'vmprofileid', description : 'The ID of the profile', type : 'uuid', length : 255, required : False, related : 'createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile'}, {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,listDomains,listDomains,moveDomain'}], response : [{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 : 'projectid', description : 'The project 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 : '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 : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'domain', description : 'The domain name of the 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 : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {}, {name : 'publicip', description : 'The public IP address', type : 'string'}, {name : 'project', description : 'The project name of the Instance group', type : 'string'}, {name : 'privateport', description : 'The private port', type : 'string'}, {name : 'lbruleid', description : 'The Load balancer rule ID', 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 : 'domainpath', description : 'path of the domain to which the vm group belongs', type : 'string'}, {name : 'publicport', description : 'The public port', type : 'string'}, {name : 'created', description : 'The date when this Instance group was created', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'publicipid', description : 'The public IP address ID', type : 'string'}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {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 : 'state', description : 'The current state of the AutoScale Instance Group', type : 'string'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}], httprequesttype : 'GET'}, {name : 'registerUserData', description : 'Register a new User Data.', since : '4.18', isasync : False, params : [{name : 'name', description : 'Name of the user data', type : 'string', length : 255, required : True}, {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 : '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 : '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}], 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 : 'listAccounts', description : 'Lists Accounts and provides detailed Account information for listed Accounts', isasync : False, related : 'disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts', params : [{name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'name', description : 'List account by account name', 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 : '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 : '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 : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'iscleanuprequired', description : 'List accounts by cleanuprequired attribute (values are true or false)', type : 'boolean', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'showicon', description : 'Flag to display the resource icon for accounts', type : 'boolean', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'tag', description : 'Tag for resource type to return usage', type : 'string', length : 255, required : False, since : '4.20.0'}, {name : 'state', description : 'List accounts by state. Valid states are enabled, disabled, and locked.', type : 'string', 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 : '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}], response : [{name : 'defaultzoneid', description : 'The default zone of the Account', type : 'string'}, {name : 'domain', description : 'Name of the Domain the Account belongs to', type : 'string'}, {name : 'cputotal', description : 'The total number of CPU cores owned by account', type : 'long'}, {name : 'bucketlimit', description : 'the total number of buckets which can be stored by this account', type : 'string'}, {name : 'vmavailable', description : 'The total number of Instances available for this Account to acquire', type : 'string'}, {name : 'networktotal', description : 'The total number of Networks owned by Account', type : 'long'}, {name : 'isdefault', description : 'True if account is default, false otherwise', type : 'boolean'}, {name : 'groups', description : 'The list of ACL groups that account belongs to', type : 'list'}, {name : 'templatetotal', description : 'The total number of Templates which have been created by this Account', type : 'long'}, {name : 'vmtotal', description : 'The total number of Instances deployed by this Account', type : 'long'}, {name : 'networklimit', description : 'The total number of Networks the Account can own', type : 'string'}, {name : 'backupstorageavailable', description : 'the total backup storage space (in GiB) available to the account', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'primarystorageavailable', description : 'The total primary storage space (in GiB) available to be used for this account', type : 'string'}, {name : 'memoryavailable', description : 'The total memory (in MB) available to be created for this account', type : 'string'}, {name : 'projectlimit', description : 'The total number of projects the Account can own', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'domainpath', description : 'Path of the Domain the Account belongs to', type : 'string'}, {name : 'backupavailable', description : 'the total number of backups available to this account', type : 'string'}, {name : 'templateavailable', description : 'The total number of Templates available to be created by this Account', type : 'string'}, {name : 'vmstopped', description : 'The total number of Instances stopped for this Account', type : 'integer'}, {name : 'networkavailable', description : 'The total number of Networks available to be created for this Account', type : 'string'}, {name : 'secondarystoragelimit', description : 'The total secondary storage space (in GiB) the account can own', type : 'string'}, {name : 'accounttype', description : 'Account type (admin, domain-admin, user)', type : 'integer'}, {name : 'templatelimit', description : 'The total number of Templates which can be created by this Account', type : 'string'}, {name : 'vpcavailable', description : 'The total number of VPCs available to be created for this account', type : 'string'}, {name : 'cpuavailable', description : 'The total number of CPU cores available to be created for this account', type : 'string'}, {name : 'volumeavailable', description : 'The total volume available for this Account', type : 'string'}, {name : 'backupstoragelimit', description : 'the total backup storage space (in GiB) the account can own', type : 'string'}, {name : 'state', description : 'The state of the account', type : 'string'}, {name : 'projectavailable', description : 'The total number of projects available for administration by this Account', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'vpclimit', description : 'The total number of VPCs the Account can own', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'taggedresources', description : 'The tagged resource limit and count for the account', type : 'list'}, {name : 'created', description : 'The date when this account was created', type : 'date'}, {name : 'networkdomain', description : 'The Network domain', type : 'string'}, {name : 'vpctotal', description : 'The total number of VPCs owned by account', type : 'long'}, {name : 'objectstorageavailable', description : 'the total object storage space (in GiB) available to the account', type : 'string'}, {name : 'user', description : 'The list of users associated with account', type : 'list', response : [{name : 'apikey', description : 'The API key of the user', type : 'string'}, {name : 'email', description : 'The user email address', type : 'string'}, {name : 'is2faenabled', description : 'True if user has two factor authentication enabled', type : 'boolean'}, {name : 'usersource', description : 'The source type of the user in lowercase, such as native, ldap, saml2', type : 'string'}, {name : 'accounttype', description : 'The Account type of the user', type : 'integer'}, {name : 'lastname', description : 'The user lastname', type : 'string'}, {name : 'timezone', description : 'The timezone user was created in', type : 'string'}, {name : 'iscallerchilddomain', description : "The boolean value representing if the updating target is in caller's child domain", type : 'boolean'}, {name : 'secretkey', description : 'The secret key of the user', type : 'string'}, {name : 'accountid', description : 'The Account ID of the user', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'domainid', description : 'The domain ID of the user', type : 'string'}, {name : 'state', description : 'The user state', type : 'string'}, {name : 'id', description : 'The user ID', type : 'string'}, {name : 'created', description : 'The date and time the user 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 : 'roletype', description : 'The type of the role', type : 'string'}, {name : 'rolename', description : 'The name of the role', type : 'string'}, {name : 'account', description : 'The Account name of the user', type : 'string'}, {name : 'username', description : 'The user name', type : 'string'}, {name : 'is2famandated', description : 'True if user has two factor authentication is mandated', type : 'boolean'}, {name : 'firstname', description : 'The user firstname', type : 'string'}, {name : 'domain', description : 'The domain name of the user', type : 'string'}, {name : 'isdefault', description : 'True if user is default, false otherwise', type : 'boolean'}, {name : 'roleid', description : 'The ID of the role', type : 'string'}]}, {name : 'gputotal', description : 'the total number of gpus owned by account', type : 'long'}, {name : 'memorytotal', description : 'The total memory (in MB) owned by account', type : 'long'}, {name : 'primarystoragelimit', description : 'The total primary storage space (in GiB) the account can own', type : 'string'}, {name : 'ipavailable', description : 'The total number of public IP addresses available for this Account to acquire', type : 'string'}, {name : 'snapshotavailable', description : 'The total number of Snapshots available for this Account', type : 'string'}, {}, {name : 'projecttotal', description : 'The total number of projects being administrated by this Account', type : 'long'}, {name : 'name', description : 'The name of the Account', type : 'string'}, {name : 'roleid', description : 'The ID of the role', type : 'string'}, {name : 'backuptotal', description : 'the total number of backups stored by this account', type : 'long'}, {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 : 'objectstoragelimit', description : 'the total object storage space (in GiB) the account can own', type : 'string'}, {name : 'memorylimit', description : 'The total memory (in MB) the account can own', type : 'string'}, {name : 'rolename', description : 'The name of the role', type : 'string'}, {name : 'snapshottotal', description : 'The total number of Snapshots stored by this Account', type : 'long'}, {name : 'backuplimit', description : 'the total number of backups which can be stored by this account', type : 'string'}, {name : 'volumetotal', description : 'The total volume being used by this Account', type : 'long'}, {name : 'gpulimit', description : 'the total number of gpus the account can own', type : 'string'}, {name : 'snapshotlimit', description : 'The total number of Snapshots which can be stored by this Account', type : 'string'}, {name : 'secondarystoragetotal', description : 'The total secondary storage space (in GiB) owned by account', type : 'float'}, {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 : 'buckettotal', description : 'the total number of buckets stored by this account', type : 'long'}, {name : 'objectstoragetotal', description : 'the total object storage space (in GiB) owned by the account', type : 'long'}, {name : 'iscleanuprequired', description : 'True if the account requires cleanup', type : 'boolean'}, {name : 'volumelimit', description : 'The total volume which can be used by this Account', type : 'string'}, {name : 'iptotal', description : 'The total number of public IP addresses allocated for this Account', type : 'long'}, {name : 'roletype', description : 'The type of the role (Admin, ResourceAdmin, DomainAdmin, User)', type : 'string'}, {name : 'vmlimit', description : 'The total number of Instances that can be deployed by this Account', type : 'string'}, {name : 'cpulimit', description : 'The total number of CPU cores the account can own', type : 'string'}, {name : 'bucketavailable', description : 'the total number of buckets available to this account', type : 'string'}, {name : 'gpuavailable', description : 'the total number of gpus available to be created for this account', type : 'string'}, {name : 'secondarystorageavailable', description : 'The total secondary storage space (in GiB) available to be used for this account', type : 'string'}, {name : 'domainid', description : 'ID of the Domain the Account belongs to', type : 'string'}, {name : 'primarystoragetotal', description : 'The total primary storage space (in GiB) owned by account', type : 'long'}, {name : 'backupstoragetotal', description : 'the total backup storage space (in GiB) owned by the account', type : 'long'}, {name : 'apikeyaccess', description : 'whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)', type : 'apikeyaccess'}, {}], 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 : '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 : '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 : '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'}, {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 : '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 : 'domainid', description : 'Domain ID of the Account owning an autoscale Instance profile', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'account', description : 'Account that will own the autoscale Instance profile', type : 'string', length : 255, required : False}, {name : 'userdataid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.18.1', related : 'listCniConfiguration'}, {name : 'zoneid', description : 'Availability zone for the auto deployed Instance', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is expunged', type : 'integer', length : 255, required : False}, {name : 'serviceofferingid', description : 'The service offering of the auto deployed Instance', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {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 : '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 : '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}], response : [{}, {name : 'userdata', description : 'Base64 encoded Instance user data', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance profile', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance profile', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'domainpath', description : 'path of the domain to which the vm profile belongs', type : 'string'}, {name : 'autoscaleuserid', description : 'The ID of the User used to launch and destroy the Instances', type : 'string'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer'}, {name : 'zoneid', description : 'The availability zone 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 : 'templateid', description : 'The Template to be used while deploying an Instance', 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'userdataid', description : 'the id of userdata used for the VM', type : 'string'}, {name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance', type : 'map'}, {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 : 'serviceofferingid', description : 'The service offering to be used while deploying an Instance', type : 'string'}, {name : 'userdatadetails', description : 'list of variables and values for the variables declared in userdata', type : 'string'}, {}, {}, {name : 'projectid', description : 'The project id Instance profile', type : 'string'}], httprequesttype : 'POST'}, {name : 'syncVmwareCbtMigration', description : 'Run a VMware CBT delta synchronization cycle', since : '4.24.0', isasync : True, related : 'listVmwareCbtMigrations,cutoverVmwareCbtMigration,cancelVmwareCbtMigration', params : [{name : 'password', description : 'optional password override for the source vCenter. Stored external vCenter credentials are used when available', type : 'string', length : 255, required : False}, {name : 'username', description : 'optional username override for the source vCenter. Stored external vCenter credentials are used when available', type : 'string', length : 255, required : False}, {name : 'id', description : 'the VMware CBT migration ID', type : 'uuid', length : 255, required : True, related : 'listVmwareCbtMigrations,syncVmwareCbtMigration,cutoverVmwareCbtMigration,cancelVmwareCbtMigration'}], response : [{name : 'virtualmachineid', description : 'the ID of the imported VM after cutover', type : 'string'}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'string'}, {name : 'currentstepduration', description : 'the elapsed time spent in the current migration step', type : 'string'}, {name : 'vcenter', description : 'the source VMware vCenter', type : 'string'}, {name : 'existingvcenterid', description : 'the linked existing vCenter ID, when used', type : 'string'}, {name : 'convertinstancehostname', description : 'the KVM host name selected for conversion and CBT replication', 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', type : 'string'}, {name : 'poolname', description : 'the storage pool name selected for converted disks', type : 'string'}, {name : 'created', description : 'the create date of the VMware CBT migration', type : 'date'}, {name : 'completedcycles', description : 'the number of completed CBT delta cycles', type : 'int'}, {name : 'datacentername', description : 'the source VMware datacenter', type : 'string'}, {name : 'lastdirtyrate', description : 'the dirty rate in bytes per second observed in the last CBT delta cycle', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'cycle', description : 'the CBT delta synchronization cycles tracked by this VMware CBT migration', type : 'list'}, {}, {name : 'lastchangedbytes', description : 'the changed bytes observed in the last CBT delta cycle', type : 'long'}, {name : 'id', description : 'the ID of the VMware CBT migration', type : 'string'}, {name : 'displayname', description : 'the display name of the target VM', type : 'string'}, {name : 'sourcecluster', description : 'the source VMware cluster', type : 'string'}, {name : 'zoneid', description : 'the destination zone ID', type : 'string'}, {name : 'lasterror', description : 'the last migration error', type : 'string'}, {name : 'zonename', description : 'the destination zone name', type : 'string'}, {name : 'currentstep', description : 'the current migration step', type : 'string'}, {name : 'quietcycles', description : 'the number of consecutive quiet CBT delta cycles', type : 'int'}, {name : 'convertinstancehostid', description : 'the KVM host selected for conversion and CBT replication', type : 'string'}, {name : 'convertinstancepoolid', description : 'the storage pool selected for converted disks', type : 'string'}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'lastupdated', description : 'the last updated date of the VMware CBT migration', type : 'date'}, {name : 'clustername', description : 'the destination KVM cluster name', type : 'string'}, {name : 'state', description : 'the migration state', type : 'string'}, {name : 'totalchangedbytes', description : 'the total changed bytes synchronized across CBT delta cycles', type : 'long'}, {name : 'disk', description : 'the source and target disks tracked by this VMware CBT migration', type : 'list'}, {name : 'sourcehost', description : 'the source VMware ESXi host', type : 'string'}], 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 : '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'}, {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'}], 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 : 'updateBackupSchedule', description : 'Updates a User-defined Instance backup schedule', since : '4.14.0', isasync : False, related : '', params : [{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 : '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 : '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 : '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 : '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'}], response : [{name : 'account', description : 'Account name', type : 'string'}, {name : 'status', description : 'Backup status', type : 'status'}, {name : 'validationstatus', description : 'Backup validation status.', type : 'validationstatus'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'name', description : 'name of the backup', type : 'string'}, {}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'id', description : 'ID of the Instance backup', 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 : 'isbackupvmexpunged', description : 'Indicates whether the VM from which the backup was taken is expunged or not', type : 'boolean'}, {name : 'backupofferingname', description : 'Backup offering name', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'externalid', description : 'External backup id', type : 'string'}, {name : 'backupofferingid', description : 'Backup offering id', type : 'string'}, {name : 'description', description : 'description for the backup', type : 'string'}, {name : 'hostid', description : 'Host ID where the backup is running', type : 'string'}, {name : 'type', description : 'Backup type', type : 'string'}, {name : 'compressionstatus', description : 'Backup compression status.', type : 'compressionstatus'}, {name : 'vmbackupofferingremoved', description : 'The backup offering corresponding to this backup was removed from the VM', type : 'boolean'}, {name : 'tocheckpointid', description : 'Next checkpoint ID for incremental backups', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'volumes', description : 'Backed up volumes', type : 'string'}, {name : 'accountid', description : 'Account id', type : 'string'}, {name : 'domain', description : 'Domain name', type : 'string'}, {name : 'vmdetails', description : 'Lists the vm specific details for the backup', type : 'map'}, {name : 'fromcheckpointid', description : 'Previous active checkpoint ID for incremental backups', type : 'string'}, {name : 'virtualsize', description : 'Backup protected (virtual) size in bytes', type : 'long'}, {name : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {name : 'domainid', description : 'Domain ID', type : 'string'}, {name : 'created', description : 'Backup date', type : 'date'}, {name : 'zone', description : 'Zone name', type : 'string'}, {name : 'intervaltype', description : 'Interval type of the backup', type : 'string'}], httprequesttype : 'POST'}, {name : 'createPrivateGateway', description : 'Creates a private gateway', since : '4.17.0', isasync : True, related : 'createPrivateGateway,listPrivateGateways', params : [{name : 'bypassvlanoverlapcheck', description : 'When true bypasses VLAN id/range overlap check during private gateway creation', type : 'boolean', length : 255, required : False}, {name : 'ipaddress', description : 'The IP address of the Private Gateway', type : 'string', length : 255, required : True}, {name : 'aclid', description : 'The ID of the Network ACL', type : 'uuid', length : 255, required : False, related : 'createNetworkACLList,listNetworkACLLists'}, {name : 'physicalnetworkid', description : 'The Physical Network ID the network belongs to', type : 'uuid', length : 255, required : False, related : 'listPhysicalNetworks,updatePhysicalNetwork'}, {name : 'vpcid', description : 'The VPC Network belongs to', type : 'uuid', length : 255, required : True, related : 'listVPCs,createVPC,listVPCs,updateVPC'}, {name : 'netmask', description : 'The Netmask of the Private Gateway', type : 'string', length : 255, required : True}, {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'}, {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 : '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 : 'vlan', description : 'The network implementation uri for the private gateway', type : 'string', length : 255, required : False}], response : [{name : 'id', description : 'The ID of the private gateway', type : 'string'}, {name : 'zonename', description : 'The name of the zone the private gateway belongs to', type : 'string'}, {name : 'vlan', description : 'The Network implementation uri for the private gateway', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'aclid', description : 'ACL ID set for 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 : 'physicalnetworkid', description : 'The physical Network id', type : 'string'}, {name : 'associatednetworkid', description : 'The ID of the Network associated with this private gateway', type : 'string'}, {name : 'associatednetwork', description : 'The name of the Network associated with this private gateway', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the private gateway', type : 'string'}, {name : 'state', description : 'State of the gateway, can be Creating, Ready, Deleting', 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 : 'domain', description : 'The domain associated with the private gateway', type : 'string'}, {name : 'gateway', description : 'The gateway', type : 'string'}, {name : 'aclname', description : 'ACL name set for private gateway', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the private gateway belongs', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'project', description : 'The project name of the private gateway', type : 'string'}, {name : 'projectid', description : 'The project ID of the private gateway', type : 'string'}, {name : 'netmask', description : "The private gateway's netmask", type : 'string'}, {name : 'account', description : 'The Account associated with the private gateway', type : 'string'}, {name : 'vpcid', description : 'VPC ID the private gateway belongs to', 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 : '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 : '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 : 'properties', description : 'used to specify the vApp properties.', type : 'map', length : 255, required : False, since : '4.15'}, {name : 'dynamicscalingenabled', description : 'true if virtual machine needs to be dynamically scalable', type : 'boolean', length : 255, required : False, since : '4.16'}, {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 : '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 : '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 : '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 : '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 : 'startvm', description : 'true if start vm after creating; defaulted to true if not specified', 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 : 'zoneid', description : 'availability zone for the virtual machine', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'name', description : 'host name for the virtual machine', type : 'string', length : 255, required : False}, {name : 'macaddress', description : "the mac address for default vm's network", type : 'string', length : 255, required : False}, {name : 'leaseduration', description : 'Number of days instance is leased for.', type : 'integer', length : 255, required : False, since : '4.21.0'}, {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 : '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 : 'userdataid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.18', related : 'listCniConfiguration'}, {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 : '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 : '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 : 'resetpassword', description : 'For a password enabled template, whether to generate a new password for the created Instance and return it in the response. If not specified, the zone setting `restore.vm.from.backup.reset.password` decides.', type : 'boolean', length : 255, required : False, since : '4.22.1.0'}, {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 : 'leaseexpiryaction', description : 'Lease expiry action, valid values are STOP and DESTROY', type : 'string', length : 255, required : False, since : '4.21.0'}, {name : 'keypair', description : 'name of the ssh key pair used to login to the virtual machine', type : 'string', length : 255, required : False}, {name : 'size', description : 'the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId', type : 'long', length : 255, required : False}, {name : 'backupid', description : 'backup ID to create the VM from', type : 'uuid', length : 255, required : True, related : ''}, {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 : 'serviceofferingid', description : 'the ID of the service offering for the virtual machine', type : 'uuid', length : 255, required : False, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {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 : 'group', description : 'an optional group for the virtual machine', type : 'string', length : 255, required : False}, {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 : 'deploymentplanner', description : 'Deployment planner to use for vm allocation. Available to ROOT admin only', type : 'string', length : 255, required : False, since : '4.4'}, {name : 'ip6address', description : "the ipv6 address for default vm's network", 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 : '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 : '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 : 'nicpackedvirtqueuesenabled', description : 'Enable packed virtqueues or not.', type : 'boolean', length : 255, required : False, since : '4.18'}, {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 : 'projectid', description : 'Deploy vm for the project', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'userdatadetails', description : 'used to specify the parameters values for the variables in userdata.', type : 'map', length : 255, required : False, since : '4.18'}, {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 : 'iodriverpolicy', description : 'Controls specific policies on IO', type : 'string', 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 : '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 : '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 : '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 : '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 : '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 : '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 : '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 : '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 : 'displayname', description : 'an optional user generated name for the virtual machine', type : 'string', 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 : '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 : '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 : 'account', description : 'an optional account for the virtual machine. Must be used with domainId.', type : 'string', length : 255, required : False}, {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 : '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 : 'ipaddress', description : "the ip address for default vm's network", type : 'string', length : 255, required : False}], response : [{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 : '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 : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {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 : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', 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 : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {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 : '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 : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', 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 : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {}, {name : 'zonename', description : 'The name of the availability zone for 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 : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of 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 : 'domain', description : 'The domain 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 : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}]}, {name : 'isdynamicallyscalable', description : 'True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.', type : 'boolean'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {}, {}, {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 : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying 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 : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', 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 : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'servicestate', description : 'State of the Service from LB rule', 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 : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used 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 : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to 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 : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', 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 : 'sentbytes', description : 'The total number of Network traffic bytes sent', 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 : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{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 : '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 : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {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 : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'traffictype', description : 'The traffic type 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 : '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 : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', 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 : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', 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 : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {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 : 'domain', description : '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 : '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 : 'resourceid', description : 'ID of the resource', 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 : 'ruleid', description : 'The ID of the security group rule', type : 'string'}, {name : 'securitygroupname', description : 'Security group name', 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 : '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 : 'protocol', description : 'The protocol of the security group rule', 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 : '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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', 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 : '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 : 'key', description : 'Tag key name', 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 : '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 : '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 : '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 : 'account', description : 'Account owning the security group rule', 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 : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', 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 : '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 : 'domain', description : 'The domain associated with the tag', type : 'string'}]}]}, {name : 'name', description : 'The name of the security group', 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 : 'project', description : 'The project name of the group', type : 'string'}, {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 : 'description', description : 'The description 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 : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {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 Instance', type : 'string'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}], httprequesttype : 'POST'}, {name : 'updateVMSchedule', description : 'Update Instance Schedule.', since : '4.19.0', isasync : False, related : '', params : [{name : 'id', description : 'ID of Instance schedule', type : 'uuid', length : 255, required : True, related : 'updateVMSchedule'}, {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 : '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 : 'enabled', description : 'Enable Instance schedule', type : 'boolean', length : 255, required : False}, {name : 'startdate', description : 'Start date from which the schedule becomes active(Format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}], response : [{name : 'description', description : 'Description of Instance schedule', type : 'string'}, {name : 'created', description : 'Date when the schedule was created', type : 'date'}, {name : 'action', description : 'Action', type : 'action'}, {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 : 'virtualmachineid', description : 'ID of Instance', type : 'string'}, {}, {name : 'enabled', description : 'VM schedule is enabled', type : 'boolean'}, {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 : 'id', description : 'The ID of Instance schedule', type : 'string'}, {name : 'enddate', description : 'Date after which the schedule becomes inactive', type : 'date'}, {name : 'startdate', description : 'Date from which the schedule is active', type : 'date'}], httprequesttype : 'POST'}, {name : 'createInstanceBootGroupReadinessRule', description : 'Creates a readiness rule for an Instance or Instance Group that is a member (directly, or via its instance group) of an Instance Boot Group', since : '24.0', isasync : False, related : 'updateInstanceBootGroupReadinessRule', params : [{name : 'details', description : 'Rule-type-specific configuration, e.g. port/protocol, script, threshold_type/threshold_value', type : 'map', length : 255, required : False}, {name : 'ruletype', description : 'The readiness rule type: GuestAgentLiveness, Ping, PortCheck or MemberQuorum', type : 'string', length : 255, required : True}, {name : 'instancegroupid', description : 'The ID of the Instance Group this rule applies to (exclusive with virtualmachineid)', type : 'uuid', length : 255, required : False, related : 'updateInstanceGroup'}, {name : 'enabled', description : 'Whether the rule is enabled; defaults to true', type : 'boolean', length : 255, required : False}, {name : 'bootgroupid', description : 'The ID of the Instance Boot Group this rule belongs to', type : 'uuid', length : 255, required : True, related : 'startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup'}, {name : 'name', description : 'The name of the readiness rule; auto-generated if not provided', type : 'string', length : 255, required : False}, {name : 'virtualmachineid', description : 'The ID of the Instance this rule applies to (exclusive with instancegroupid)', 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'}], response : [{name : 'memberid', description : 'The ID of the item (VM or instance group) this rule applies to', type : 'string'}, {name : 'id', description : 'The ID of the readiness rule', type : 'string'}, {name : 'inherited', description : "True if this rule is not attached to the queried item directly, but inherited from its owning InstanceGroup (only possible when listing by virtualmachineid; the rule's itemtype/itemid still refer to the InstanceGroup it's actually attached to)", type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'membername', description : 'The name of the item (VM or instance group) this rule applies to', type : 'string'}, {name : 'bootgroupid', description : 'The ID of the boot group this rule belongs to', type : 'string'}, {name : 'created', description : 'The date the rule was created', type : 'date'}, {name : 'enabled', description : 'Whether the rule is enabled', type : 'boolean'}, {name : 'checkedon', description : 'When this rule was last evaluated', type : 'date'}, {}, {name : 'ruletype', description : 'The readiness rule type', type : 'string'}, {name : 'membertype', description : 'The item type this rule applies to: VirtualMachine or InstanceGroup', type : 'string'}, {name : 'statusmessage', description : 'The message from the last evaluation of this rule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'readinessstatus', description : 'The last cached evaluation status of this rule: READY, NOT_READY, ERROR or UNKNOWN', type : 'string'}, {name : 'details', description : 'Rule-type-specific configuration', type : 'map'}, {}, {name : 'name', description : 'The name of the readiness rule', type : 'string'}], httprequesttype : 'POST'}, {name : 'listGpuDevices', description : 'Lists all available GPU devices', since : '4.21.0', isasync : False, related : 'listGpuDevices,discoverGpuDevices,createGpuDevice', params : [{name : 'gpucardid', description : 'the GPU card ID associated with the GPU device', type : 'uuid', length : 255, required : False, related : 'listGpuCards'}, {name : 'vgpuprofileid', description : 'the vGPU profile ID assigned to the GPU device', type : 'uuid', length : 255, required : False, related : 'createVgpuProfile,updateVgpuProfile'}, {name : 'id', description : 'ID of the GPU device', type : 'uuid', length : 255, required : False, related : 'listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice'}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'hostid', description : 'the host ID where the GPU device is attached', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,listHosts,reconnectHost'}, {name : 'pagesize', 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 : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'hostname', description : 'the host name where the GPU device is attached', type : 'string'}, {}, {name : 'busaddress', description : 'bus address of the GPU device or MDEV UUID for vGPU devices', type : 'string'}, {name : 'gpucardid', description : 'the GPU card ID associated with this GPU device', type : 'string'}, {name : 'state', description : 'the vGPU profile name assigned to this GPU device', type : 'state'}, {name : 'virtualmachinename', description : 'the vGPU profile name assigned to this GPU device', type : 'string'}, {name : 'managedstate', description : 'the managed state of the GPU device (Enabled/Disabled)', type : 'managedstate'}, {name : 'vgpuprofilename', description : 'the vGPU profile name assigned to this GPU device', type : 'string'}, {name : 'vmstate', description : 'the state of the virtual machine to which this GPU device is allocated', type : 'state'}, {name : 'parentgpudeviceid', description : 'the ID of the parent GPU device, if this is a vGPU', type : 'string'}, {name : 'gpudevicetype', description : 'bus address of the GPU device', type : 'devicetype'}, {name : 'hostid', description : 'the host ID where the GPU device is attached', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'gpucardname', description : 'the GPU card name associated with this GPU device', type : 'string'}, {name : 'id', description : 'the ID of the GPU device', type : 'string'}, {}, {name : 'vgpuprofileid', description : 'the vGPU profile ID assigned to this GPU device', type : 'string'}, {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'}], httprequesttype : 'GET'}, {name : 'assignVirtualMachineToBackupOffering', description : 'Assigns an Instance to a backup offering', since : '4.14.0', isasync : True, params : [{name : 'backupofferingid', description : 'ID of the backup offering', type : 'uuid', length : 255, required : True, related : 'listBackupOfferings,updateBackupOffering,createBackupOffering'}, {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'}], 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 : 'listResourceIcon', description : 'Lists the resource icon for the specified resource(s)', since : '4.16.0.0', isasync : False, related : '', 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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'base64image', description : 'Base64 representation of resource icon', 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 : 'resourcetype', description : 'Resource type', type : 'resourceobjecttype'}], httprequesttype : 'GET'}, {name : 'listVirtualMachinesMetrics', description : 'Lists VM metrics', isasync : False, related : 'listVirtualMachinesMetrics', params : [{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 : '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 : 'hypervisor', description : 'The target hypervisor for the Template', 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 : 'hostid', description : 'The host ID', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,listHosts,reconnectHost'}, {name : 'serviceofferingid', description : 'List by the service offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'leased', description : 'Whether to return only leased instances', 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 : 'updateSecurityGroup'}, {name : 'groupid', description : 'The group ID', type : 'uuid', length : 255, required : False, related : 'updateInstanceGroup'}, {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 : '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 : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains,moveDomain'}, {name : 'clusterid', description : 'The cluster ID', type : 'uuid', length : 255, required : False, related : 'addCluster,updateCluster'}, {name : 'backupofferingid', description : 'List by the backup offering', type : 'uuid', length : 255, required : False, since : '4.17', related : 'listBackupOfferings,updateBackupOffering,createBackupOffering'}, {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 : 'podid', description : 'The pod ID', type : 'uuid', length : 255, required : False, related : 'listPods,createManagementNetworkIpRange'}, {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 : 'isoid', description : 'List Instances by ISO', type : 'uuid', length : 255, required : False}, {name : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", 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 : 'showicon', description : 'Flag to display the resource icon for Instances', type : 'boolean', length : 255, required : False, since : '4.16.0.0'}, {name : 'pagesize', description : '', type : 'integer', 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 : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', 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 : 'arch', description : 'CPU arch of the VM', type : 'string', length : 255, required : False, since : '4.20.1'}, {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 : 'zoneid', description : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'userdataid', description : 'the instances by userdata', type : 'uuid', length : 255, required : False, since : '4.20.1', related : 'listCniConfiguration'}, {name : 'keyword', description : 'List by keyword', 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 : '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 : '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 : '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 : '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 : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', 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 : 'vpcid', description : 'List Instances by VPC', type : 'uuid', length : 255, required : False, related : 'listVPCs,createVPC,listVPCs,updateVPC'}, {name : 'affinitygroupid', description : 'List Instances by affinity group', type : 'uuid', length : 255, required : False, related : 'createAffinityGroup,listAffinityGroups'}, {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 : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}], response : [{name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'diskiopstotal', description : 'The total disk iops', type : 'long'}, {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 : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'projectid', description : 'The project ID the tag belongs to', 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 : '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 : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'videoram', description : 'the video RAM size in MB', 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 : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'cputotal', description : 'The total cpu capacity in Ghz', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'memorytotal', description : 'The total memory capacity in GiB', type : 'string'}, {}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', 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 : '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 : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{name : 'egressrule', description : 'The list of egress rules associated with the security group', type : 'set', response : [{name : 'account', description : 'Account owning the security group rule', 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 : '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 : '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 : '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 : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {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 : 'protocol', description : 'The protocol 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 : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', 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 : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{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 : '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 : 'project', description : 'The project name where tag belongs to', 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 : 'domain', description : 'The domain associated with the tag', 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 : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}, {name : 'projectid', description : 'The project id of the 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 : 'securitygroupname', description : 'Security group name', 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 : '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 : '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 : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{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 : 'domain', description : '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 : '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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'ruleid', description : 'The ID of the security group rule', type : 'string'}]}]}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {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 : 'domainpath', description : 'Path of the domain in which the virtual machine exists', 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 : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', 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 : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', 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 : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {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 : 'type', description : 'The type 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 : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'id', description : 'The 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 : 'domain', description : 'The domain name of the affinity group', 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 : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'networkwrite', description : 'Network write in MiB', type : 'string'}, {name : 'networkread', description : 'Network read in MiB', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', 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 : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'diskread', description : 'Disk read in MiB', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', 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 : '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 : '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 : 'name', description : 'The name of the attached ISO', type : 'string'}]}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', 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 : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'diskwrite', description : 'Disk write in MiB', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'hostname', description : 'The name of the host for 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 : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', 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 : '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 : '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 : '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 : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', 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 : '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 : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', 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 : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {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 : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', 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 Instance', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', 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 : '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 : '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 : 'id', description : 'The ID of the public IP address to reserve', type : 'uuid', length : 255, required : True, related : 'associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses'}, {name : 'fordisplay', description : 'An optional field, whether to the display the IP to the end User or not', type : 'boolean', length : 255, required : False}, {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 : 'account', description : 'The Account to reserve with this IP address', type : 'string', length : 255, required : False}], response : [{name : 'associatednetworkname', description : 'The name of the Network associated with the IP address', type : 'string'}, {name : 'vlanname', description : 'The VLAN associated with the IP address', type : 'string'}, {name : 'vmipaddress', description : 'Instance (DNAT) IP address (not null only for static NAT IP)', type : 'string'}, {name : 'virtualmachinedisplayname', description : 'Instance display name the IP address is assigned to (not null only for static NAT IP)', type : 'string'}, {name : 'forprovider', description : 'true if range is dedicated for external network providers', type : 'boolean'}, {name : 'zonename', description : 'The name of the zone the public IP address belongs to', type : 'string'}, {name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {name : 'isstaticnat', description : 'True if this IP is for static NAT, false otherwise', type : 'boolean'}, {name : 'virtualmachinetype', description : 'Instance type the IP address is assigned to', type : 'string'}, {name : 'virtualmachinename', description : 'Instance name the IP address is assigned to', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'vpcid', description : 'VPC ID the IP belongs to', type : 'string'}, {name : 'issourcenat', description : 'True if the IP address is a source NAT address, false otherwise', type : 'boolean'}, {name : 'account', description : 'The Account the public IP address is associated with', type : 'string'}, {name : 'virtualmachineid', description : 'Instance id the IP address is assigned to', type : 'string'}, {name : 'hasrules', description : 'Whether the IP address has Firewall/PortForwarding/LoadBalancing rules defined', type : 'boolean'}, {name : 'state', description : 'State of the IP address. Can be: Allocating, Allocated, Releasing, Reserved and Free', type : 'string'}, {name : 'isportable', description : 'Is public IP portable across the zones', type : 'boolean'}, {name : 'domain', description : 'The domain the public IP address is associated with', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the IP address', type : 'boolean'}, {name : 'allocated', description : 'Date the public IP address was acquired', type : 'date'}, {name : 'domainid', description : 'The domain ID the public IP address is associated with', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated with IP address', type : 'list', response : [{name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', 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 : '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 : 'domainpath', description : 'Path of the Domain 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 : 'domainpath', description : 'path of the domain to which the public IP address belongs', type : 'string'}, {name : 'fordisplay', description : 'Is public IP for display to the regular user', type : 'boolean'}, {name : 'project', description : 'The project name of the address', type : 'string'}, {name : 'ipaddress', description : 'Public IP address', 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 : 'vpcname', description : 'VPC name the IP belongs to', type : 'string'}, {name : 'associatednetworkid', description : 'The ID of the Network associated with the IP address', type : 'string'}, {name : 'issystem', description : 'True if this IP is system IP (was allocated as a part of deployVm or createLbRule)', type : 'boolean'}, {name : 'zoneid', description : 'The ID of the zone the public IP address belongs to', type : 'string'}, {name : 'networkid', description : 'The ID of the Network where IP belongs to', 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 : 'id', description : 'Public IP address ID', type : 'string'}, {name : 'physicalnetworkid', description : 'The physical Network this belongs to', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'networkname', description : 'The name of the Network where IP belongs to', type : 'string'}, {name : 'forsystemvms', description : 'true if range is dedicated for System VMs', type : 'boolean'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'deleteVMSchedule', description : 'Delete Instance Schedule.', since : '4.19.0', isasync : False, params : [{name : 'ids', description : 'IDs of Instance schedule', type : 'list', length : 255, required : False, related : ''}, {name : 'id', description : 'ID of Instance schedule', type : 'uuid', length : 255, required : False, related : ''}, {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'}], 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 : 'deleteDnsRecord', description : 'Deletes a DNS record from the external provider', since : '4.23.0', isasync : True, params : [{name : 'name', description : '', type : 'string', length : 255, required : True}, {name : 'dnszoneid', description : 'The ID of the DNS zone', type : 'uuid', length : 255, required : True, related : 'listDnsZones'}, {name : 'type', description : '', type : 'string', 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 : '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 : '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 : '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 : 'projectroleid', description : 'The ID of the project role to which the role permission belongs', type : 'string'}, {name : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'description', description : 'The description of the role permission', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'permission', description : 'The permission type of the api name or wildcard rule, allow/deny', type : 'string'}, {name : 'rule', description : 'The api name or wildcard rule', 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 project role permission', type : 'string'}, {name : 'projectrolename', description : 'The name of the project role to which the role permission belongs', 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 : 'encryption', description : 'Enable bucket encryption', type : 'boolean', length : 255, required : False}, {name : 'account', description : 'the account associated with the bucket. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'name', description : 'the name of the bucket', type : 'string', length : 255, required : True}, {name : 'projectid', description : 'the project associated with the bucket. Mutually exclusive with account parameter', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'quota', description : 'Bucket Quota in GiB', type : 'integer', length : 255, required : True}, {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 : 'versioning', description : 'Enable bucket versioning', type : 'boolean', length : 255, required : False}, {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 : 'objectlocking', description : 'Enable object locking in bucket', type : 'boolean', length : 255, required : False}], response : [{}, {}, {name : 'domainid', description : 'the ID of the domain associated with the bucket', type : 'string'}, {name : 'account', description : 'the account associated with the Bucket', type : 'string'}, {name : 'project', description : 'the project name of the bucket', type : 'string'}, {name : 'created', description : 'the date the Bucket was created', type : 'date'}, {name : 'quota', description : 'Bucket Quota in GiB', type : 'integer'}, {name : 'provider', description : 'Object storage provider', type : 'string'}, {name : 'domain', description : 'the domain associated with the bucket', type : 'string'}, {name : 'versioning', description : 'Bucket Versioning', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'value', description : 'Tag value', 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 : 'resourcetype', description : 'Resource type', 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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer 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 : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'domainpath', description : 'path of the domain to which the bucket belongs', type : 'string'}, {name : 'objectstorageid', description : 'id of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'size', description : 'Total size of objects in Bucket', type : 'long'}, {name : 'policy', description : 'Bucket Access Policy', type : 'string'}, {name : 'objectstore', description : 'Name of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'objectlocking', description : 'Bucket Object Locking', type : 'boolean'}, {name : 'projectid', description : 'the project id of the bucket', type : 'string'}, {name : 'encryption', description : 'Bucket Encryption', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : '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 : 'state', description : 'State of the Bucket', type : 'string'}, {name : 'accesskey', description : 'Bucket Access Key', type : 'string'}, {name : 'id', description : 'ID of the Bucket', type : 'string'}, {name : 'url', description : 'Bucket URL', type : 'string'}], httprequesttype : 'POST'}, {name : 'listRoutingFirewallRules', description : 'Lists all Routing firewall rules', since : '4.20.0', isasync : False, related : 'createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule', 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 : 'networkid', description : 'list Routing firewall rules by network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}, {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 : 'createProject'}, {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 : 'fordisplay', description : 'list resources by display flag; only ROOT admin is eligible to pass this parameter', type : 'boolean', 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 : 'traffictype', description : 'list Routing firewall rules by traffic type - ingress or egress', type : 'string', length : 255, required : False}, {name : 'id', description : 'Lists Routing firewall rule with the specified ID', type : 'uuid', length : 255, required : False, related : 'listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule'}, {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 : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}], response : [{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 : 'cidrlist', description : 'The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).', type : 'string'}, {name : 'privateport', description : "The starting 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 : '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 : '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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'vmguestip', description : 'The Instance IP address for the port forwarding rule', type : 'string'}, {}, {name : 'protocol', description : 'The protocol of the port forwarding 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 : 'domain', description : '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 : '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 : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'projectid', description : 'The project ID the 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 : 'publicendport', description : "The ending port of port forwarding rule's private port range", type : 'string'}, {name : 'fordisplay', description : 'Is firewall for display to the regular user', type : 'boolean'}, {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 : 'networkname', description : 'The Name of the guest Network the port forwarding rule belongs to', type : 'string'}, {name : 'id', description : 'The ID of the port forwarding rule', 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 : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {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'}], 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 : 'listBackupOfferings', description : 'Lists backup offerings', since : '4.14.0', isasync : False, related : 'updateBackupOffering,createBackupOffering', params : [{name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'The zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'id', description : 'The backup offering ID', type : 'uuid', length : 255, required : False, related : 'listBackupOfferings,updateBackupOffering,createBackupOffering'}, {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 : '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 : 'createDomain,listDomains,listDomains'}, {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}], response : [{name : 'provider', description : 'provider name', type : 'string'}, {name : 'zoneid', description : 'Zone ID', type : 'string'}, {name : 'domain', description : 'the domain name(s) this backup offering belongs to.', type : 'string'}, {name : 'id', description : 'ID of the backup offering', type : 'string'}, {}, {name : 'zonename', description : 'Zone name', type : 'string'}, {name : 'crosszoneinstancecreation', description : 'the backups with this offering can be used to create Instances on all Zones', type : 'boolean'}, {name : 'domainid', description : 'the domain ID(s) this backup offering belongs to.', type : 'string'}, {name : 'allowuserdrivenbackups', description : 'Whether the offering allows User driven ad-hoc/scheduled backups', 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 : 'description', description : 'Description for the backup offering', type : 'string'}, {name : 'backupofferingdetails', description : 'Details for the backup offering', type : 'map'}, {name : 'name', description : 'Name for the backup offering', type : 'string'}, {name : 'created', description : 'The date this backup offering was created', type : 'date'}, {name : 'externalid', description : 'External ID on the provider side', 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 : 'pagesize', 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 : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : 'createProject'}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', 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 : 'forcks', description : 'list templates that can be used to deploy CKS clusters', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'oscategoryid', description : 'the ID of the OS category for the template', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listOsCategories'}, {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 : '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 : '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 : '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 : 'name', description : 'The Template name', type : 'string', length : 255, required : False}, {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 : 'showremoved', description : 'Show removed Templates as well', type : 'boolean', length : 255, required : False}, {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 : 'page', description : '', type : 'integer', length : 255, required : False}, {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 : '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 : 'zoneid', description : 'List Templates by zoneId', type : 'uuid', length : 255, required : False, related : 'listZones'}, {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 : 'showunique', description : 'If set to true, list only unique Templates across zones', type : 'boolean', length : 255, required : False, since : '4.13.2'}, {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 : 'isready', description : 'list templates that are ready to be deployed', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'hypervisor', description : 'The hypervisor for which to restrict the search', type : 'string', length : 255, required : False}, {name : 'showicon', description : 'Flag to display the resource image for the Templates', type : 'boolean', length : 255, required : False}], response : [{name : 'extensionname', description : 'The name of extension linked to this template', type : 'string'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}, {name : 'passwordenabled', description : 'True if the reset password feature is enabled, false otherwise', type : 'boolean'}, {name : 'name', description : 'The Template name', type : 'string'}, {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 : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'id', description : 'The Template ID', type : 'string'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {name : 'format', description : 'The format of the Template.', type : 'imageformat'}, {name : 'removed', description : 'The date this Template was removed', type : 'date'}, {name : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {name : 'ispublic', description : 'True if this Template is a public Template, false otherwise', type : 'boolean'}, {name : 'userdataid', description : 'The id of userdata linked to this 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 : 'sourcetemplateid', description : 'The Template ID of the parent Template if present', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {name : 'extensionid', description : 'The ID of extension linked to this 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 : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {name : 'directdownload', description : 'KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage', type : 'boolean'}, {name : 'crossZones', description : 'True if the Template is managed across all Zones, false otherwise', type : 'boolean'}, {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 : 'status', description : 'The status of the Template', type : 'string'}, {name : 'url', description : 'The URL which the Template/ISO is registered from', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', type : 'string'}, {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 : 'project', description : 'The project name where tag belongs to', 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 : '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 : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'accountid', description : 'The Account id to which the Template belongs', type : 'string'}, {name : 'project', description : 'The project name of the Template', type : 'string'}, {}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'templatetag', description : 'The tag of this Template', type : 'string'}, {}, {name : 'sshkeyenabled', description : 'True if Template is sshkey enabled, false otherwise', type : 'boolean'}, {name : 'isready', description : 'True if the Template is ready to be deployed from, false otherwise.', type : 'boolean'}, {name : 'requireshvm', description : 'True if Template requires HVM enabled, false otherwise', type : 'boolean'}, {name : 'userdataname', description : 'The name of userdata linked to this 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 : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean'}, {name : 'account', description : 'The Account name to which the Template belongs', type : 'string'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'displaytext', description : 'The Template display text', type : 'string'}, {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 : 'bits', description : 'The processor bit size', type : 'int'}, {}, {name : 'checksum', description : 'Checksum of the Template', type : 'string'}, {name : 'arch', description : 'CPU Arch of the template', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {name : 'hostname', description : 'The name of the secondary storage host for the Template', type : 'string'}, {name : 'domainid', description : 'The ID of the domain to which the Template belongs', type : 'string'}, {name : 'hostid', description : 'The ID 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 : 'isextractable', description : 'True if the Template is extractable, 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 : '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 : 'volumeid', description : '', type : 'uuid', length : 255, required : False, since : '4.21', related : 'importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}, {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 : 'leaseexpiryaction', description : 'Lease expiry action, valid values are STOP and DESTROY', type : 'string', length : 255, required : False, since : '4.21.0'}, {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 : 'iodriverpolicy', description : 'Controls specific policies on IO', type : 'string', length : 255, required : False}, {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 : '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 : '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 : 'startvm', description : 'true if start vm after creating; defaulted to true if not specified', type : 'boolean', length : 255, required : False}, {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 : 'dynamicscalingenabled', description : 'true if virtual machine needs to be dynamically scalable', type : 'boolean', length : 255, required : False, since : '4.16'}, {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 : 'size', description : 'the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId', type : 'long', 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 : 'leaseduration', description : 'Number of days instance is leased for.', type : 'integer', length : 255, required : False, since : '4.21.0'}, {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 : '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 : 'ip6address', description : "the ipv6 address for default vm's network", type : 'string', length : 255, required : False}, {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 : '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 : 'name', description : 'host name for the virtual machine', type : 'string', length : 255, required : False}, {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 : '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 : 'userdataid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.18', related : 'listCniConfiguration'}, {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 : '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 : 'macaddress', description : "the mac address for default vm's network", 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 : '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,reconnectHost'}, {name : 'properties', description : 'used to specify the vApp properties.', type : 'map', length : 255, required : False, since : '4.15'}, {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 : 'snapshotid', description : '', type : 'uuid', length : 255, required : False, since : '4.21', related : 'createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots'}, {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 : '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 : 'group', description : 'an optional group for the virtual machine', type : 'string', 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 : '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 : 'displayname', description : 'an optional user generated name for the virtual machine', type : 'string', length : 255, required : False}, {name : 'account', description : 'an optional account for the virtual machine. Must be used with domainId.', type : 'string', 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 : 'serviceofferingid', description : 'The ID of the Service offering for the Instance', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}, {name : 'nicmultiqueuenumber', description : 'The number of queues for multiqueue NICs.', type : 'integer', length : 255, required : False, since : '4.18'}, {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 : 'userdatadetails', description : 'used to specify the parameters values for the variables in userdata.', type : 'map', length : 255, required : False, since : '4.18'}, {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 : 'zoneid', description : 'availability zone for the virtual machine', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'keypair', description : 'name of the ssh key pair used to login to 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 : '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 : '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 : 'nicpackedvirtqueuesenabled', description : 'Enable packed virtqueues or not.', type : 'boolean', length : 255, required : False, since : '4.18'}, {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 : 'ipaddress', description : "the ip address for default vm's network", type : 'string', length : 255, required : False}, {name : 'projectid', description : 'Deploy vm for the project', type : 'uuid', length : 255, required : False, related : 'createProject'}, {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 : '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 : '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}], response : [{}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {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 : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{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 : 'endport', description : 'The ending IP of the security group rule ', 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 : '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 : '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 : 'account', description : 'The Account 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 : '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 : '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 : 'key', description : 'Tag key name', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {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 : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}]}, {name : 'domain', description : 'The domain name of the security 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 : 'domainpath', description : 'path of the Domain the security group belongs to', type : 'string'}, {name : 'virtualmachinecount', description : 'The number of Instances associated with this Security Group', type : 'integer'}, {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 : '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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'resourcetype', description : 'Resource type', 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 : '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 : 'value', description : 'Tag value', 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 : '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 : '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 : 'account', description : 'Account owning the security group rule', type : 'string'}]}, {name : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'projectid', description : 'The project id of the group', type : 'string'}, {name : 'account', description : 'The Account owning the security group', 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 : '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 : '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 : '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 : 'domainpath', description : 'Path of the Domain associated with the tag', 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 : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'memoryintfreekbs', description : "The internal memory (KiB) that's free in Instance or zero if it can not be calculated", type : 'long'}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', 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 : 'projectid', description : 'The project ID the tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', 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 : 'resourceid', description : 'ID of the resource', 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 : 'domain', description : 'The domain associated with the tag', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', 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 : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {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 : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', 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 : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by 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 : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {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 : '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 : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {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 : '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 : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'traffictype', description : 'The traffic type of the NIC', 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 : '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 : '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 : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {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 : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {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 : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'netmask', description : 'The netmask 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 : 'username', description : "The User's name who deployed the Instance", 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 : '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 : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {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 : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', 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 : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', 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 : '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 : 'virtualmachineIds', description : 'Instance IDs associated with this affinity group', type : 'list'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', type : 'string'}, {name : 'id', description : 'The ID 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 : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}]}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone 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 : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'isoid', description : 'The ID 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 : '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 : 'id', description : 'The ID of the attached ISO', type : 'string'}]}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", 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 : '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 : '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 : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{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 : '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 : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', 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 : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', 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 : '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 : 'vpcid', description : 'ID of the VPC to which the NIC belongs', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {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 : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", 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 : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'traffictype', description : 'The traffic type of the NIC', 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 : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}]}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourceid', description : 'ID of the resource', 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 : 'resourcetype', description : 'Resource type', 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 : '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 : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'domainpath', description : 'path of the domain to which the shared filesystem', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}], 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 : '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'}, {name : 'networkid', description : 'The ID of the network', type : 'uuid', length : 255, required : True, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks'}], 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 : 'networkid', description : 'The ID of the 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 mapping', type : 'string'}, {name : 'dnszoneid', description : 'The ID of the DNS zone', type : 'string'}], httprequesttype : 'POST'}, {name : 'scaleKubernetesCluster', description : 'Scales a created, running or stopped CloudManaged Kubernetes cluster', isasync : True, related : 'createKubernetesCluster,startKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{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 : '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 : '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 : 'minsize', description : 'Minimum number of worker nodes in the cluster', type : 'long', length : 255, required : False}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,updateKubernetesClusterAffinityGroups'}, {name : 'size', description : 'Number of Kubernetes cluster nodes', type : 'long', length : 255, required : False}, {name : 'maxsize', description : 'Maximum number of worker nodes in the cluster', type : 'long', length : 255, required : False}], response : [{name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {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 : 'zoneid', description : 'The name of the zone of the Kubernetes cluster', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {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'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for 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 : '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 : 'templateid', description : 'The ID 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 : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {}, {name : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'etcdaffinitygroupids', description : 'The IDs of affinity groups associated with etcd nodes', type : 'string'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {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 : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the 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 : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'etcdofferingid', description : 'the ID 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 : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on 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 : 'serviceofferingid', description : 'The ID 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 : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}], httprequesttype : 'POST'}, {name : 'destroyVolume', description : 'Destroys a Volume.', since : '4.14.0', isasync : True, related : 'importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume', 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 : 'importVolume,createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}], response : [{name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'serviceofferingid', description : 'ID of the service offering for root disk', type : 'string'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {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 : 'path', description : 'The path of the volume', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', type : 'boolean'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', 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 : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {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 : 'status', description : 'The status of the volume', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the Instance', 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 : 'vmstate', description : 'State of the Instance', 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 : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {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 disk volume', type : 'string'}, {}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'diskofferingname', description : 'Name of the disk offering', 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 : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'kmskeyid', description : 'KMS key id 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 : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'storage', description : 'Name of the primary storage hosting the disk volume', type : 'string'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", 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 : 'customer', description : 'Customer 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 : '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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}]}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}], httprequesttype : 'POST'}, {name : 'stopSharedFileSystem', description : 'Stop a Shared FileSystem', since : '4.20.0', isasync : True, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering', params : [{name : 'forced', description : 'Force stop the shared filesystem.', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}], response : [{name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'volumename', description : 'name of the storage fs data volume', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'serviceofferingname', description : 'service offering 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 : '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 : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', 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 : '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 : '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 : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {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 : 'ip6gateway', description : 'The gateway of IPv6 Network', 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 : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', 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 : 'networkname', description : 'The name of the corresponding Network', 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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}]}, {}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', 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 : '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 : '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 : 'key', description : 'Tag key name', type : 'string'}, {name : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'projectid', description : 'the project ID of 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 : '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 : '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 : 'id', description : 'The ID of the System VM', type : 'uuid', length : 255, required : True, related : 'startSystemVm,changeServiceForSystemVm'}, {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 : 'serviceofferingid', description : 'The service offering ID to apply to the System VM', type : 'uuid', length : 255, required : True, related : 'createServiceOffering,updateServiceOffering,listServiceOfferings'}], response : [{name : 'id', description : 'The ID of the System VM', type : 'string'}, {name : 'storageip', description : 'the ip address for the system VM on the storage network', type : 'string'}, {name : 'publicip', description : 'The public IP address for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the System VM', type : 'string'}, {name : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', 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 : '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 : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'disconnected', description : 'The last disconnected date of host', type : 'date'}, {}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {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 : 'linklocalip', description : 'The Control IP address for the System VM', 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 : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'publicvlan', description : 'Public VLAN range', type : 'list'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', 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 : 'hostcontrolstate', description : 'The control state of the host for the System VM', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'podid', description : 'The Pod ID for the System VM', type : 'string'}, {name : 'dns1', description : 'The first DNS for the System VM', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', 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 : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'gateway', description : 'The gateway for the System VM', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {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'}], 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 : '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 : 'listConsoleSessions', description : 'Lists console sessions.', since : '4.21.0', isasync : False, related : '', params : [{name : 'hostid', description : 'Lists console sessions from the specified host.', type : 'uuid', length : 255, required : False, related : 'declareHostAsDegraded,reconnectHost'}, {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 : '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 : '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 : 'domainid', description : 'The domain ID of the account that created the console endpoint.', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,listDomains'}, {name : 'pagesize', description : '', type : 'integer', 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 : 'id', description : 'The ID of the console session.', type : 'uuid', length : 255, required : False, related : 'listConsoleSessions'}, {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 : 'userid', description : 'The ID of the user that created the console endpoint.', type : 'uuid', length : 255, required : False, related : 'disableUser,getUser,listUsers,lockUser'}, {name : 'consoleendpointcreatoraddress', description : 'IP address of the creator of the console endpoint.', type : 'string', length : 255, required : False}, {name : 'clientaddress', description : 'IP address of the client that accessed the console session.', type : 'string', 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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'page', 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}], response : [{name : 'domainpath', description : 'Domain path of the account that created the console endpoint.', type : 'string'}, {name : 'userid', description : 'ID of the user that created the console endpoint.', type : 'string'}, {name : 'consoleendpointcreatoraddress', description : 'IP address of the creator of the console endpoint.', type : 'string'}, {name : 'created', description : "Date when the console session's endpoint was created.", type : 'date'}, {name : 'domain', description : 'Domain of the account that created the console endpoint.', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the virtual machine.', type : 'string'}, {name : 'domainid', description : 'Domain ID of the account that created the console endpoint.', type : 'string'}, {name : 'account', description : 'Account that created the console endpoint.', type : 'string'}, {name : 'id', description : 'ID of the console session.', type : 'string'}, {name : 'acquired', description : 'Date when the console session was acquired.', type : 'date'}, {name : 'hostname', description : 'Name of the host.', type : 'string'}, {name : 'removed', description : 'Date when the console session was removed.', type : 'date'}, {}, {name : 'user', description : 'User that created the console endpoint.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'accountid', description : 'ID of the account that created the console endpoint.', type : 'string'}, {name : 'hostid', description : 'ID of the host.', type : 'string'}, {}, {name : 'virtualmachinename', description : 'Name of the virtual machine.', type : 'string'}, {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'}], httprequesttype : 'GET'}, {name : 'listCniConfiguration', description : 'List user data for CNI plugins', since : '4.21.0', isasync : False, related : '', 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 : '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 : '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 : '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 : '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,listDomains,listDomains'}], response : [{name : 'account', description : 'The owner of the User Data', type : 'string'}, {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 : 'domainpath', description : 'Path of the domain to which the User Data owner belongs', type : 'string'}, {name : 'projectid', description : 'The project id of the User Data', 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'}, {name : 'name', description : 'Name of the User Data', type : 'string'}, {name : 'id', description : 'ID of the User Data', type : 'string'}, {name : 'domain', description : 'The domain name of the User Data owner', type : 'string'}, {name : 'userdata', description : 'Base64 encoded User Data content', 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 : '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'}], 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 : 'name', description : 'The name of the Snapshot', type : 'string', length : 255, required : False}, {name : 'vmsnapshotid', description : 'The ID of the Instance Snapshot', type : 'uuid', length : 255, required : True, related : 'listVMSnapshot,createVMSnapshot'}, {name : 'volumeid', description : 'The ID of the disk volume', type : 'uuid', length : 255, required : True, related : 'importVolume,createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume'}], response : [{name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'account', description : 'The Account associated with the Snapshot', 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 : 'zonename', description : 'name of the availability zone', type : 'string'}, {name : 'osdisplayname', description : 'Display name of the os on volume', type : 'string'}, {name : 'name', description : 'Name of the Snapshot', type : 'string'}, {name : 'datastorestate', description : 'state of the snapshot on the datastore', type : 'string'}, {name : 'virtualsize', description : 'Virtual size of backedup Snapshot on image store', type : 'long'}, {}, {name : 'intervaltype', description : 'Valid types are hourly, daily, weekly, monthy, Template, and none.', type : 'string'}, {name : 'ostypeid', description : 'ID of the os on volume', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'physicalsize', description : 'Physical size of backed up Snapshot on image store', type : 'long'}, {name : 'snapshottype', description : 'The type of the Snapshot', type : 'string'}, {name : 'volumeid', description : 'ID of the disk volume', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'id', description : 'ID of the Snapshot', type : 'string'}, {name : 'domainid', description : "The domain ID of the Snapshot's Account", type : 'string'}, {name : 'created', description : 'The date the Snapshot was created', type : 'date'}, {name : 'project', description : 'The project name of the Snapshot', type : 'string'}, {name : 'volumename', description : 'Name of the disk volume', type : 'string'}, {name : 'volumestate', description : 'state of the disk volume', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'domainpath', description : "path of the Domain the snapshot's account belongs to", type : 'string'}, {name : 'status', description : 'the status of the template', type : 'string'}, {name : 'parentname', description : 'The parent name of the Snapshot', 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 : 'datastoreid', description : 'ID of the datastore for the snapshot entry', type : 'string'}, {name : 'downloaddetails', description : 'download progress of a snapshot', type : 'map'}, {name : 'parent', description : 'The parent ID of the Snapshot', type : 'string'}, {name : 'domain', description : "The domain name of the Snapshot's Account", type : 'string'}, {name : 'datastoretype', description : 'type of the datastore for the snapshot entry', type : 'string'}, {name : 'locationtype', description : 'Valid location types are primary and secondary.', type : 'string'}, {name : 'projectid', description : 'The project id of the Snapshot', type : 'string'}, {}, {name : 'volumetype', description : 'Type of the disk volume', type : 'string'}, {name : 'revertable', description : 'Indicates whether the underlying storage supports reverting the volume to this Snapshot', type : 'boolean'}, {name : 'datastorename', description : 'name of the datastore for the snapshot entry', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{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 : '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 : '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 : 'resourceid', description : 'ID of the resource', type : 'string'}]}], httprequesttype : 'POST'}, {name : 'listDnsServers', description : 'Lists DNS servers owned by the account.', since : '4.23.0', isasync : False, related : 'addDnsServer', 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 : 'id', description : 'the ID of the DNS server', type : 'uuid', length : 255, required : False, related : 'addDnsServer,listDnsServers'}, {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 : '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 : '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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'url', description : 'URL of the DNS server API', type : 'string'}, {name : 'account', description : 'the account associated with the DNS server', 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 server', type : 'string'}, {name : 'provider', description : 'The provider type of the DNS server', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with 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 : '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 : 'ispublic', description : 'Is the DNS server publicly available', type : 'boolean'}, {name : 'name', description : 'Name of the DNS server', type : 'string'}, {name : 'port', description : 'The port of the DNS server', type : 'integer'}], httprequesttype : 'GET'}, {name : 'startInstanceBootGroup', description : 'Starts all Instances in an Instance Boot Group in order (lowest boot order first). Instances within the same order tier start concurrently', since : '24.0', isasync : True, related : 'stopInstanceBootGroup,rebootInstanceBootGroup', params : [{name : 'id', description : 'The ID of the Instance Boot Group', type : 'uuid', length : 255, required : True, related : 'startInstanceBootGroup,stopInstanceBootGroup,rebootInstanceBootGroup'}], response : [{name : 'readinessattempttimeoutseconds', description : 'Effective timeout in seconds for each readiness retry attempt (per-boot-group override if set, else the global default)', type : 'long'}, {}, {name : 'domainid', description : 'The domain ID of the instance boot group', type : 'string'}, {name : 'id', description : 'The ID of the instance boot group', 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 instance boot group', type : 'string'}, {}, {name : 'account', description : 'The account owning the instance boot group', type : 'string'}, {name : 'domainpath', description : 'The path of the domain the instance boot group belongs to', type : 'string'}, {name : 'domain', description : 'The domain name of the instance boot group', type : 'string'}, {name : 'readinessrebootonretry', description : 'Effective setting for whether an instance is rebooted between readiness retry attempts (per-boot-group override if set, else the global default)', type : 'boolean'}, {name : 'description', description : 'The description of the instance boot group', type : 'string'}, {name : 'readinessmaxretryattempts', description : 'Effective maximum number of readiness retry attempts (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'name', description : 'The name of the instance boot group', 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 boot group', type : 'string'}, {name : 'created', description : 'The date the instance boot group was created', type : 'date'}, {name : 'accountid', description : 'The account ID owning the instance boot group', type : 'string'}, {name : 'readinessinitialdelayseconds', description : 'Effective delay in seconds after starting or rebooting an instance before its first readiness check of that attempt (per-boot-group override if set, else the global default)', type : 'long'}], httprequesttype : 'POST'}, {name : 'listBuckets', description : 'Lists all Buckets.', since : '4.19.0', isasync : False, related : '', params : [{name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', length : 255, required : False}, {name : 'id', description : 'the ID of the bucket', type : 'uuid', length : 255, required : False, related : 'listBuckets'}, {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 : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'createDomain,listDomains,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 : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'ids', description : 'the IDs of the Buckets, mutually exclusive with id', type : 'list', length : 255, required : False, related : 'listBuckets'}, {name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', 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 : 'name', description : 'the name of the bucket', 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}], response : [{name : 'usersecretkey', description : 'Bucket Secret Key', type : 'string'}, {name : 'quota', description : 'Bucket Quota in GiB', type : 'integer'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'value', description : 'Tag value', 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 : 'domainpath', description : 'Path 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 : 'account', description : 'The Account associated with the tag', type : 'string'}, {name : 'resourceid', description : 'ID of the resource', 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 : 'created', description : 'the date the Bucket was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'objectstorageid', description : 'id of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'policy', description : 'Bucket Access Policy', type : 'string'}, {name : 'provider', description : 'Object storage provider', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the bucket belongs', type : 'string'}, {name : 'objectstore', description : 'Name of the object storage hosting the Bucket; returned to admin user only', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the bucket', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'objectlocking', description : 'Bucket Object Locking', type : 'boolean'}, {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 : 'account', description : 'the account associated with 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 : 'id', description : 'ID of the Bucket', type : 'string'}, {}, {name : 'accesskey', description : 'Bucket Access Key', type : 'string'}, {name : 'encryption', description : 'Bucket Encryption', type : 'boolean'}, {name : 'versioning', description : 'Bucket Versioning', type : 'boolean'}, {}, {name : 'url', description : 'Bucket URL', type : 'string'}, {name : 'projectid', description : 'the project id of the bucket', type : 'string'}, {name : 'state', description : 'State of the Bucket', type : 'string'}], httprequesttype : 'GET'}, {name : 'stopInternalLoadBalancerVM', description : 'Stops an Internal LB Instance.', isasync : True, related : 'listRouters,changeServiceForRouter,listInternalLoadBalancerVMs', 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 internal LB Instance', type : 'uuid', length : 255, required : True, related : 'listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs'}], response : [{name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {name : 'linklocalnetworkid', description : 'The ID of the corresponding link local Network', type : 'string'}, {name : 'domain', description : 'The domain associated with the router', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'account', description : 'The Account associated with the router', type : 'string'}, {name : 'name', description : 'The name of the router', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with the router', type : 'set', response : [{name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', 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 : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', 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 : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', 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 : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {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 : '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 : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {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 : 'publicip', description : 'Public IP address associated with this NIC via Static NAT rule', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', 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 : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}]}, {name : 'version', description : 'The version of Template', type : 'string'}, {name : 'created', description : 'The date and time the router was created', type : 'date'}, {name : 'hostid', description : 'The host ID for the router', type : 'string'}, {name : 'publicip', description : 'The public IP address for the router', type : 'string'}, {name : 'guestnetworkid', description : 'The ID of the corresponding guest Network', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the router', type : 'string'}, {name : 'templatename', description : 'The Template name for the router', type : 'string'}, {name : 'healthchecksfailed', description : 'True if any health checks had failed', type : 'boolean'}, {name : 'networkdomain', description : 'The Network domain for the router', type : 'string'}, {name : 'guestnetworkname', description : 'The name of the corresponding guest Network', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the router', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'vpcname', description : 'The name of VPC the router belongs to', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask 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 : 'publicnetworkid', description : 'The ID of the corresponding public Network', type : 'string'}, {name : 'isredundantrouter', description : 'If this router is an redundant virtual router', type : 'boolean'}, {name : 'gateway', description : 'The gateway for the router', type : 'string'}, {name : 'domainid', description : 'The domain ID associated with the router', type : 'string'}, {name : 'requiresupgrade', description : 'True if the router Template requires upgrade', type : 'boolean'}, {name : 'guestmacaddress', description : 'The guest MAC address for the router', type : 'string'}, {name : 'ip6dns2', description : 'The second IPv6 DNS for the router', type : 'string'}, {name : 'templateid', description : 'The Template ID for the router', type : 'string'}, {name : 'zonename', description : 'The Zone name for the router', type : 'string'}, {name : 'dns1', description : 'The first DNS for the router', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the router', type : 'string'}, {name : 'softwareversion', description : 'The version of the code / software in the router', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the router belongs to', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address for the router', type : 'string'}, {}, {name : 'dns2', description : 'The second DNS for the router', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'redundantstate', description : 'The state of redundant virtual router', type : 'string'}, {name : 'role', description : 'Role of the domain router', type : 'string'}, {name : 'healthcheckresults', description : 'Last executed health check result for the router', type : 'list', response : [{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 : 'checkname', description : 'The name of the health check on the router', type : 'string'}, {name : 'details', description : 'Detailed response generated on running health check', type : 'string'}, {name : 'checktype', description : 'The type of the health check - basic or advanced', type : 'string'}, {name : 'status', description : 'the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}', type : 'routerhealthstatus'}]}, {name : 'podid', description : 'The Pod ID for the router', type : 'string'}, {name : 'state', description : 'The state of the router', type : 'state'}, {name : 'hostcontrolstate', description : 'The control state of the host for the router', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'guestipaddress', description : 'The guest IP address for the router', type : 'string'}, {name : 'arch', description : 'CPU arch of the router', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the router', type : 'string'}, {name : 'ip6dns1', description : 'The first IPv6 DNS for the router', 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 router', type : 'string'}, {}, {name : 'podname', description : 'The Pod name for the router', type : 'string'}, {name : 'id', description : 'The ID of the router', type : 'string'}, {name : 'vpcid', description : 'VPC the router belongs to', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'project', description : 'The project name of the address', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteUserData', description : 'Deletes a userdata', since : '4.18', isasync : False, params : [{name : 'account', description : 'An optional account for the userdata. Must be used with domainId.', type : 'string', length : 255, required : False}, {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 : '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 : ''}], 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 : 'listVmsForImport', description : 'Lists virtual machines on a unmanaged host', since : '4.19.0', isasync : False, related : 'listVmwareDcVms,listUnmanagedInstances', params : [{name : 'host', description : 'the host name or IP address', type : 'string', length : 255, required : True}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'username', description : 'the username for the host', type : 'string', length : 255, required : False}, {name : 'password', description : 'the password for the host', type : 'string', length : 255, required : False}, {name : 'hypervisor', description : 'hypervisor type of the host', type : 'string', length : 255, required : True}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'clustername', description : 'the name of the cluster to which virtual machine belongs', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'disk', description : 'The list of disks associated with the Instance', type : 'set', response : [{name : 'capacity', description : 'The capacity of the disk in bytes', type : 'long'}, {name : 'controller', description : 'The controller of the disk', type : 'string'}, {name : 'imagepath', description : 'The file path of the disk image', type : 'string'}, {name : 'datastoretype', description : 'The controller of the disk', type : 'string'}, {name : 'position', description : 'The position of the disk', type : 'integer'}, {name : 'datastorehost', description : 'The controller of the disk', type : 'string'}, {name : 'label', description : 'The label of the disk', type : 'string'}, {name : 'datastorename', description : 'The controller of the disk', type : 'string'}, {name : 'id', description : 'The ID 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 : 'clusterid', description : 'The ID of the cluster to which Instance belongs', type : 'string'}, {name : 'cpuspeed', description : 'The CPU speed of the Instance', 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 : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'osdisplayname', description : 'The operating system of the Instance', type : 'string'}, {}, {name : 'nic', description : 'The list of NICs associated with the Instance', type : 'set', response : [{name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', 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 : 'networkid', description : 'The ID of the corresponding Network', 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 : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', 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 : '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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', 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 : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {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 : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}]}, {name : 'hypervisor', description : 'The hypervisor to which Instance belongs', type : 'string'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'memory', description : 'The memory of the Instance in MB', type : 'integer'}, {}, {name : 'osid', description : 'The operating system ID of the Instance', type : 'string'}, {name : 'boottype', description : 'indicates the boot type', type : 'string'}, {name : 'powerstate', description : 'The power state of the Instance', type : 'string'}, {name : 'bootmode', description : 'indicates the boot mode', type : 'string'}, {name : 'hostid', description : 'The ID of the host to which Instance belongs', type : 'string'}, {name : 'cpucorepersocket', description : 'The CPU cores per socket for the Instance. VMware specific', type : 'integer'}, {name : 'hostname', description : 'The name of the host to which Instance belongs', 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 : '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 : 'listProjectRoles', description : 'Lists Project roles in CloudStack', since : '4.15.0', isasync : False, related : 'updateProjectRole', params : [{name : 'projectid', description : 'List project role by project ID.', type : 'uuid', length : 255, required : True, related : ''}, {name : 'name', description : 'List project role by project role name.', 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 : '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 role', type : 'string'}, {name : 'description', description : 'The description of the role', type : 'string'}, {name : 'id', description : 'The ID of the role', 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 : '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'}], httprequesttype : 'GET'}, {name : 'restoreBackup', description : 'Restores an existing stopped or deleted Instance using an Instance backup', since : '4.14.0', isasync : True, params : [{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 : '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 : 'id', description : 'ID of the backup', 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 : '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 : 'listDnsZones', description : 'Lists DNS zones.', since : '4.23.0', isasync : False, related : '', params : [{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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'List DNS zone by ID', type : 'uuid', length : 255, required : False, related : 'listDnsZones'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'domain', description : 'the name of the domain associated with the DNS zone', type : 'string'}, {name : 'networkid', description : 'ID of the network this zone is associated with', type : 'string'}, {name : 'dnsservername', description : 'the name of the DNS server hosting this zone', type : 'string'}, {name : 'id', description : 'ID of the DNS zone', type : 'string'}, {name : 'networkname', description : 'Name of the network this zone is associated with', 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 DNS zone', type : 'string'}, {name : 'type', description : 'The type of the zone (Public/Private)', type : 'zonetype'}, {}, {name : 'dnsserverid', description : 'ID of the DNS server this zone belongs to', type : 'string'}, {name : 'dnsserveraccount', description : 'the account name of the DNS server owner', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'description', description : 'Description for the DNS zone', type : 'string'}, {}, {name : 'state', description : 'The state of the zone (Active/Inactive)', type : 'state'}, {name : 'account', description : 'the account associated with the DNS zone', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the DNS server', type : 'string'}], httprequesttype : 'GET'}, {name : 'listInstanceBootGroupMembers', description : 'Lists members of an Instance Boot Group, sorted by boot order', since : '24.0', isasync : False, related : 'addMemberToInstanceBootGroup', params : [{name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'ignoreinstancestate', description : "If true, readiness status/message reflect the last cached rule check regardless of the member's current instance state. If false (default), an Instance that isn't Running is always reported NotReady, even if its rules were last cached Ready", type : 'boolean', length : 255, required : False}, {name : 'membertype', description : 'Filter by member type: VirtualMachine or InstanceGroup', type : 'string', length : 255, required : False}, {name : 'bootgroupid', description : 'The ID of the Instance Boot Group', type : 'uuid', length : 255, required : True, related : 'stopInstanceBootGroup,rebootInstanceBootGroup'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'details', description : 'Comma separated list of additional details requested, value can be a list of [all, readiness, children]. Readiness fields are computed from cached check results (not a live re-check) and are omitted unless requested, since computing them is not free. Children returns the member Instances of InstanceGroup-type members (omitted for VirtualMachine-type members); combine with readiness to also include per-child readiness', type : 'list', length : 255, required : False}], response : [{name : 'order', description : 'The boot order value for this member', type : 'int'}, {name : 'membertype', description : 'The type of the member: VirtualMachine or InstanceGroup', type : 'string'}, {}, {name : 'readinessmode', description : 'None, CHILD_DEPENDENT or RULE_BASED, computed from whether readiness rules are attached', 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 this member entry', type : 'string'}, {name : 'bootgroupid', description : 'The ID of the boot group this member belongs to', type : 'string'}, {name : 'readinessmessage', description : "Why readinessstatus is what it is: the failing rule(s)' cached message, and/or a count of not-ready member VMs for InstanceGroup members", type : 'string'}, {name : 'membername', description : 'The name of the VM or InstanceGroup', type : 'string'}, {name : 'memberid', description : 'The ID of the VM or InstanceGroup', type : 'string'}, {name : 'children', description : 'For InstanceGroup members, the VMs within the group (only present when requested via details=children)', type : 'list'}, {name : 'created', description : 'The date the member was added to the boot group', type : 'date'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'memberstate', description : 'The state of the Instance', type : 'string'}, {name : 'readinessstatus', description : 'The last cached readiness evaluation', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateVmNic', description : 'Updates the specified VM NIC', isasync : True, related : '', params : [{name : 'nicid', description : 'NIC ID', type : 'uuid', length : 255, required : True, related : 'updateVmNic'}, {name : 'enabled', description : 'If true, sets the NIC state to UP; otherwise, sets the NIC state to DOWN', type : 'boolean', length : 255, required : False}], response : [{name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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 : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', 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 : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'gateway', description : 'The gateway 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 : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', 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 : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {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 : '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 : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {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 : 'vpcname', description : 'Name of the VPC to which the NIC belongs', 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 : 'cniconfig', description : 'CNI Configuration content to be registered as User data', type : 'string', length : 1048576, required : False}, {name : 'projectid', description : 'an optional project for the user data', type : 'uuid', length : 255, required : False, related : ''}, {name : 'params', description : 'comma separated list of variables declared in user data content', type : 'string', length : 255, required : False}, {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 : 'account', description : 'an optional account for the user data. Must be used with domainId.', type : 'string', length : 255, required : False}, {name : 'name', description : 'Name of the user data', 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 : '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 : '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 : '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 : '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 : '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}, {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 : ''}], response : [{name : 'status', description : 'The status of the Template', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {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 : 'passwordenabled', description : 'True if the reset password feature is enabled, false otherwise', type : 'boolean'}, {name : 'isextractable', description : 'True if the Template is extractable, false otherwise', type : 'boolean'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}, {name : 'accountid', description : 'The Account id to which the Template belongs', type : 'string'}, {name : 'userdataname', description : 'The name of userdata linked to this Template', type : 'string'}, {name : 'id', description : 'The Template ID', type : 'string'}, {name : 'ostypeid', description : 'The ID of the OS type for this Template.', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'removed', description : 'The date this Template was removed', type : 'date'}, {name : 'crossZones', description : 'True if the Template is managed across all Zones, false otherwise', type : 'boolean'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}, {name : 'project', description : 'The project name of the Template', type : 'string'}, {name : 'bits', description : 'The processor bit size', type : 'int'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean'}, {name : 'account', description : 'The Account name to which the Template belongs', 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 : 'hostid', description : 'The ID of the secondary storage host for the Template', type : 'string'}, {name : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'zonename', description : 'The name of the zone for this Template', 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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'customer', description : 'Customer 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 : 'value', description : 'Tag value', 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 : 'resourcetype', description : 'Resource type', 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 : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'parenttemplateid', description : 'If Datadisk Template, then id of the root disk Template this Template belongs to', type : 'string'}, {name : 'domain', description : 'The name of the domain to which the Template belongs', type : 'string'}, {name : 'directdownload', description : 'KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage', type : 'boolean'}, {name : 'extensionid', description : 'The ID of extension linked to this template', type : 'string'}, {name : 'userdataid', description : 'The id of userdata linked to this Template', type : 'string'}, {name : 'name', description : 'The Template name', type : 'string'}, {name : 'hostname', description : 'The name of the secondary storage host for the Template', type : 'string'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {name : 'format', description : 'The format of the Template.', type : 'imageformat'}, {name : 'size', description : 'The size of the Template', type : 'long'}, {name : 'arch', description : 'CPU Arch of the template', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', 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 : 'extensionname', description : 'The name of extension linked to this template', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', 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 : 'domainid', description : 'The ID of the domain to which the Template belongs', type : 'string'}, {name : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {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 : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {name : 'displaytext', description : 'The Template display text', type : 'string'}, {name : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {}, {name : 'checksum', description : 'Checksum of the Template', type : 'string'}], httprequesttype : 'POST'}, {name : 'listCustomActions', description : 'Lists the custom actions', since : '4.21.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 : 'resourcetype', description : 'Type of the resource for actions', type : 'string', length : 255, required : False}, {name : 'name', description : 'Name of the custom action', type : 'string', length : 255, required : False}, {name : 'resourceid', description : 'ID of a resource for actions', type : 'string', length : 255, required : False}, {name : 'extensionid', description : 'uuid of the extension', type : 'uuid', length : 255, required : False, related : 'listExtensions,updateExtension'}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'id', description : 'uuid of the custom action', type : 'uuid', length : 255, required : False, related : 'listCustomActions'}, {name : 'enabled', description : 'List actions whether they are enabled or not', type : 'boolean', length : 255, required : False}], response : [{name : 'name', description : 'Name of the custom action', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'created', description : 'Creation timestamp of the custom action', type : 'date'}, {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'}, {name : 'extensionname', description : 'Name of the extension that this custom action belongs to', type : 'string'}, {name : 'timeout', description : 'Specifies the timeout in seconds to wait for the action to complete before failing', type : 'integer'}, {name : 'id', description : 'ID of the custom action', type : 'string'}, {name : 'enabled', description : 'Whether the custom action is enabled or not', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'details', description : 'Details of the custom action', type : 'map'}, {name : 'resourcetype', description : 'Resource type for which the action is available', type : 'string'}, {name : 'allowedroletypes', description : 'List of role types allowed for the custom action', type : 'list'}, {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 : 'name', description : 'Name of the parameter', type : 'string'}, {name : 'type', description : 'Type of the parameter', type : 'string'}, {name : 'valueoptions', description : 'Comma-separated list of options for value of the parameter', type : 'list'}, {name : 'required', description : 'Whether the parameter is required or not', type : 'boolean'}, {name : 'validationformat', description : 'Validation format for value of the parameter. Available for specific types', type : 'string'}]}, {name : 'description', description : 'Description of the custom 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 : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'name', description : 'Name of the container cluster', type : 'string'}, {name : 'configdata', description : 'The config data of the cluster', 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 container cluster', type : 'string'}], 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 : '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 : 'listInternalLoadBalancerVMs', description : 'List internal LB Instances.', isasync : False, related : 'listRouters', params : [{name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'zoneid', description : 'The Zone ID of the Internal LB Instance', type : 'uuid', length : 255, required : False, related : 'listZones'}, {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 : '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 : '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 : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'forvpc', description : 'If true is passed for this parameter, list only VPC Internal LB Instances', type : 'boolean', 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'}, {name : 'name', description : 'The name of the Internal LB Instance', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'state', description : 'The state of the Internal LB Instance', type : 'string', 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 : 'vpcid', description : 'List Internal LB Instances by VPC', type : 'uuid', length : 255, required : False, related : 'listVPCs,createVPC,listVPCs,updateVPC'}, {name : 'podid', description : 'The Pod ID of the Internal LB Instance', type : 'uuid', length : 255, required : False, related : 'createManagementNetworkIpRange'}, {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 : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork'}], response : [{name : 'redundantstate', description : 'The state of redundant virtual router', type : 'string'}, {name : 'templatename', description : 'The Template name for the router', type : 'string'}, {name : 'guestnetworkname', description : 'The name of the corresponding guest Network', type : 'string'}, {name : 'created', description : 'The date and time the router was created', type : 'date'}, {name : 'vpcid', description : 'VPC the router belongs to', type : 'string'}, {name : 'name', description : 'The name of the router', type : 'string'}, {name : 'hostcontrolstate', description : 'The control state of the host for the router', type : 'string'}, {name : 'zoneid', description : 'The Zone ID for the router', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the router belongs to', type : 'string'}, {name : 'isredundantrouter', description : 'If this router is an redundant virtual router', type : 'boolean'}, {name : 'guestipaddress', description : 'The guest IP address for the router', type : 'string'}, {name : 'dns1', description : 'The first DNS for the router', type : 'string'}, {name : 'project', description : 'The project name of the address', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with the router', type : 'set', response : [{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 : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {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 : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', 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 : 'vpcname', description : 'Name of the VPC to which the NIC belongs', 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 : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'networkid', description : 'The ID of the corresponding 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 : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {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 : 'macaddress', description : 'True if NIC is default, false otherwise', 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 : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}]}, {name : 'dns2', description : 'The second DNS for the router', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the router', type : 'string'}, {name : 'vpcname', description : 'The name of VPC the router belongs to', type : 'string'}, {name : 'state', description : 'The state of the router', type : 'state'}, {name : 'arch', description : 'CPU arch of the router', type : 'string'}, {}, {name : 'gateway', description : 'The gateway for the router', type : 'string'}, {name : 'hostid', description : 'The host ID for the router', type : 'string'}, {name : 'healthchecksfailed', description : 'True if any health checks had failed', type : 'boolean'}, {name : 'publicmacaddress', description : 'The public MAC address for the router', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'templateid', description : 'The Template ID for the router', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the router', type : 'string'}, {name : 'podname', description : 'The Pod name for the router', type : 'string'}, {name : 'requiresupgrade', description : 'True if the router Template requires upgrade', type : 'boolean'}, {name : 'domain', description : 'The domain associated with the router', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'role', description : 'Role of the domain router', type : 'string'}, {name : 'guestnetmask', description : 'The guest netmask for the router', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'ip6dns1', description : 'The first IPv6 DNS for the router', type : 'string'}, {name : 'linklocalnetworkid', description : 'The ID of the corresponding link local Network', type : 'string'}, {name : 'healthcheckresults', description : 'Last executed health check result for the router', type : 'list', response : [{name : 'status', description : 'the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}', type : 'routerhealthstatus'}, {name : 'lastupdated', description : 'The date this VPC was created', type : 'date'}, {name : 'checkname', description : 'The name of the health check on the router', type : 'string'}, {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 : 'checktype', description : 'The type of the health check - basic or advanced', type : 'string'}]}, {name : 'version', description : 'The version of Template', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'domainid', description : 'The domain ID associated with the router', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the router', type : 'string'}, {name : 'projectid', description : 'The project id of the IP address', type : 'string'}, {name : 'publicnetworkid', description : 'The ID of the corresponding public Network', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the router', type : 'string'}, {name : 'zonename', description : 'The Zone name for the router', type : 'string'}, {name : 'publicip', description : 'The public IP address for the router', type : 'string'}, {name : 'account', description : 'The Account associated with the router', type : 'string'}, {}, {name : 'id', description : 'The ID of the router', type : 'string'}, {name : 'scriptsversion', description : 'The version of scripts', type : 'string'}, {name : 'ip6dns2', description : 'The second IPv6 DNS for the router', type : 'string'}, {name : 'softwareversion', description : 'The version of the code / software in the router', type : 'string'}, {name : 'guestmacaddress', description : 'The guest MAC address for the router', type : 'string'}, {name : 'guestnetworkid', description : 'The ID of the corresponding guest Network', type : 'string'}, {name : 'hostname', description : 'The hostname for the router', type : 'string'}, {name : 'publicnetmask', description : 'The public netmask for the router', type : 'string'}, {name : 'podid', description : 'The Pod ID for the router', type : 'string'}], httprequesttype : 'GET'}, {name : 'uploadResourceIcon', description : 'Uploads an icon for the specified resource(s)', since : '4.16.0.0', isasync : False, 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}, {name : 'base64image', description : 'Base64 string representation of the resource icon/image', type : 'string', length : 2097152, required : True}], 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 : 'listHSMProfiles', description : 'Lists HSM profiles', since : '4.23.0', isasync : False, related : '', params : [{name : 'id', description : 'the HSM profile ID', type : 'uuid', length : 255, required : False, related : 'listHSMProfiles'}, {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 : 'keyword', description : 'List by keyword', 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 : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', 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 : 'protocol', description : 'the protocol of the HSM profile', type : 'string', length : 255, required : False}, {name : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'enabled', description : 'list only enabled 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 : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}], response : [{name : 'id', description : 'the ID of the HSM profile', type : 'string'}, {name : 'project', description : 'the project name of the HSM profile owner', type : 'string'}, {name : 'ispublic', description : 'whether this is a system HSM profile available to all users globally', type : 'boolean'}, {name : 'domainpath', description : 'the domain path of the HSM profile owner', type : 'string'}, {}, {name : 'protocol', description : 'the protocol of the HSM profile', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'vendor', description : 'the vendor name of the HSM profile', type : 'string'}, {name : 'state', description : 'the state of the HSM profile', type : 'string'}, {}, {name : 'name', description : 'the name of the HSM profile', type : 'string'}, {name : 'zonename', description : 'the zone name where the HSM profile is available', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'details', description : 'HSM configuration details (sensitive values are encrypted)', type : 'map'}, {name : 'accountid', description : 'the account ID of the HSM profile owner', type : 'string'}, {name : 'zoneid', description : 'the zone ID where the HSM profile is available', type : 'string'}, {name : 'domain', description : 'the domain name of the HSM profile owner', type : 'string'}, {name : 'created', description : 'the date the HSM profile was created', type : 'date'}, {name : 'account', description : 'the account name of the HSM profile owner', type : 'string'}, {name : 'domainid', description : 'the domain ID of the HSM profile owner', type : 'string'}, {name : 'enabled', description : 'whether the HSM profile is enabled', type : 'boolean'}, {name : 'projectid', description : 'the project ID of the HSM profile owner', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateAutoScaleVmProfile', description : 'Updates an existing autoscale Instance profile.', isasync : True, related : 'listAutoScaleVmProfiles', params : [{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 : 'serviceofferingid', description : 'The service offering of the auto deployed  Instance', type : 'uuid', length : 255, required : False, since : '4.18.0', related : 'updateServiceOffering,listServiceOfferings'}, {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 : '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 : '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 : 'userdataid', description : 'the ID of the userdata', type : 'uuid', length : 255, required : False, since : '4.18.1', related : ''}, {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'}, {name : 'id', description : 'The ID of the autoscale Instance profile', type : 'uuid', length : 255, required : True, related : 'listAutoScaleVmProfiles,updateAutoScaleVmProfile'}, {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 : '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 : '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 : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer', length : 255, required : False}], response : [{name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance', type : 'map'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer'}, {name : 'userdata', description : 'Base64 encoded Instance user data', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {}, {name : 'zoneid', description : 'The availability zone to be used while deploying an Instance', type : 'string'}, {name : 'templateid', description : 'The Template 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'}, {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 : 'userdatapolicy', description : 'the userdata override policy with the userdata provided while deploying VM', type : 'string'}, {name : 'fordisplay', description : 'Is profile for display to the regular User', type : 'boolean'}, {name : 'id', description : 'The autoscale Instance profile ID', type : 'string'}, {}, {}, {}, {name : 'projectid', description : 'The project id Instance profile', type : 'string'}, {name : 'serviceofferingid', description : 'The service offering to be used while deploying an Instance', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance profile', type : 'string'}, {name : 'userdataid', description : 'the id of userdata used for the VM', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance profile', type : 'string'}, {name : 'userdataname', description : 'the name of userdata used for the VM', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the vm profile belongs', type : 'string'}, {name : 'userdatadetails', description : 'list of variables and values for the variables declared in userdata', type : 'string'}, {name : 'project', description : 'The project name of the Instance profile', 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 : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'scaleuppolicies', description : 'List of scaleup autoscale policies', type : 'list'}, {name : 'fordisplay', description : 'Is group for display to the regular User', type : 'boolean'}, {}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {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 : 'id', description : 'The autoscale Instance group ID', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance group', type : 'string'}, {name : 'availablevirtualmachinecount', description : 'The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group', type : 'int'}, {name : 'project', description : 'The project name of the Instance group', type : 'string'}, {name : 'associatednetworkid', description : 'The id of the guest Network the LB rule belongs to', type : 'string'}, {name : 'state', description : 'The current state of the AutoScale Instance Group', 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 : 'publicipid', description : 'The public IP address ID', 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 Instance group', type : 'string'}, {name : 'lbruleid', description : 'The Load balancer rule ID', type : 'string'}, {name : 'vmprofileid', description : 'The autoscale profile that contains information about the Instances in the Instance group.', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance group', type : 'string'}, {name : 'created', description : 'The date when this Instance group was created', type : 'date'}, {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 : '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 : 'interval', description : 'The frequency at which the conditions have to be evaluated', type : 'int'}, {name : 'scaledownpolicies', description : 'List of scaledown autoscale policies', type : 'list'}, {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'}, {name : 'name', description : 'The name of the autoscale Instance group ', type : 'string'}], httprequesttype : 'POST'}, {name : 'deleteWebhookDelivery', description : 'Deletes Webhook delivery', since : '4.20.0', isasync : False, params : [{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 : '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 : 'id', description : 'The ID of the Webhook delivery', type : 'uuid', length : 255, required : False, related : ''}, {name : 'managementserverid', description : 'The ID of the management server', 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 : 'listVmwareDcVms', description : 'Lists the VMs in a VMware Datacenter', isasync : False, related : 'listUnmanagedInstances', params : [{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 : 'keyword', description : 'List by keyword', type : 'string', 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 : 'existingvcenterid', description : 'UUID of a linked existing vCenter', type : 'uuid', length : 255, required : False, related : ''}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'password', description : 'The password for specified username.', type : 'string', length : 255, required : False}, {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 : 'datacentername', description : 'Name of VMware datacenter.', type : 'string', length : 255, required : False}], response : [{name : 'osid', description : 'The operating system ID of the Instance', type : 'string'}, {name : 'osdisplayname', description : 'The operating system of the Instance', type : 'string'}, {}, {name : 'cpucorepersocket', description : 'The CPU cores per socket for the Instance. VMware specific', type : 'integer'}, {name : 'memory', description : 'The memory of the Instance in MB', type : 'integer'}, {name : 'clusterid', description : 'The ID of the cluster to which Instance belongs', type : 'string'}, {name : 'clustername', description : 'the name of the cluster to which virtual machine belongs', 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 : 'disk', description : 'The list of disks associated with the Instance', type : 'set', response : [{name : 'label', description : 'The label of the disk', type : 'string'}, {name : 'controller', description : 'The controller of the disk', type : 'string'}, {name : 'datastorepath', description : 'The controller of the disk', type : 'string'}, {name : 'datastorename', description : 'The controller of the disk', type : 'string'}, {name : 'imagepath', description : 'The file path of the disk image', type : 'string'}, {name : 'datastorehost', description : 'The controller of the disk', type : 'string'}, {name : 'id', description : 'The ID of the disk', type : 'string'}, {name : 'capacity', description : 'The capacity of the disk in bytes', type : 'long'}, {name : 'controllerunit', description : 'The controller unit of the disk', type : 'integer'}, {name : 'position', description : 'The position of the disk', type : 'integer'}, {name : 'datastoretype', description : 'The controller of the disk', type : 'string'}]}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor to which Instance belongs', type : 'string'}, {name : 'boottype', description : 'indicates the boot type', type : 'string'}, {name : 'cpuspeed', description : 'The CPU speed of the Instance', type : 'integer'}, {name : 'hypervisorversion', description : 'The hypervisor version of the host to which Instance belongs', type : 'string'}, {name : 'hostname', description : 'The name of the host to which Instance belongs', type : 'string'}, {name : 'hostid', description : 'The ID of the host to which Instance belongs', type : 'string'}, {name : 'bootmode', description : 'indicates the boot mode', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'cpunumber', description : 'The CPU cores of the Instance', type : 'integer'}, {}, {name : 'nic', description : 'The list of NICs associated with the Instance', type : 'set', response : [{name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {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 : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {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 : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {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 : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', 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 : 'vpcname', description : 'Name of the VPC to which the NIC belongs', 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 : 'networkid', description : 'The ID of the corresponding Network', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}]}], 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 : 'apikey', description : 'The API key of the registered user', 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 : 'secretkey', description : 'The secret key of the registered user', type : 'string'}, {name : 'apikeyaccess', description : 'Whether API key access is allowed or not', type : 'boolean'}, {}], httprequesttype : 'GET'}, {name : 'deleteInstanceBootGroup', description : 'Deletes an Instance Boot Group', since : '24.0', isasync : False, params : [{name : 'id', description : 'The ID of the Instance Boot Group', type : 'uuid', length : 255, required : True, related : 'stopInstanceBootGroup,rebootInstanceBootGroup'}], 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 : 'rebootInstanceBootGroup', description : 'Reboots all VMs in an Instance Boot Group: stops in reverse order then starts in forward order', since : '24.0', isasync : True, related : 'stopInstanceBootGroup', params : [{name : 'forced', description : 'Whether to force stop every Instance in the Instance Boot Group during the stop phase of the reboot (It is force-stopped and then started)', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The ID of the Instance Boot Group', type : 'uuid', length : 255, required : True, related : 'stopInstanceBootGroup,rebootInstanceBootGroup'}], response : [{name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'created', description : 'The date the instance boot group was created', type : 'date'}, {name : 'name', description : 'The name of the instance boot group', type : 'string'}, {name : 'accountid', description : 'The account ID owning the instance boot group', type : 'string'}, {name : 'domainpath', description : 'The path of the domain the instance boot group belongs to', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'domain', description : 'The domain name of the instance boot group', type : 'string'}, {name : 'id', description : 'The ID of the instance boot group', type : 'string'}, {name : 'account', description : 'The account owning the instance boot group', type : 'string'}, {name : 'project', description : 'The project name of the instance boot group', type : 'string'}, {name : 'readinessinitialdelayseconds', description : 'Effective delay in seconds after starting or rebooting an instance before its first readiness check of that attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'readinessattempttimeoutseconds', description : 'Effective timeout in seconds for each readiness retry attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'description', description : 'The description of the instance boot group', type : 'string'}, {name : 'readinessmaxretryattempts', description : 'Effective maximum number of readiness retry attempts (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'readinessrebootonretry', description : 'Effective setting for whether an instance is rebooted between readiness retry attempts (per-boot-group override if set, else the global default)', type : 'boolean'}, {name : 'projectid', description : 'The project ID of the instance boot group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the instance boot group', type : 'string'}], httprequesttype : 'POST'}, {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 : 'keybits', description : 'Key size for new KEK (default: same as current)', type : 'integer', length : 255, required : False}, {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 : 'id', description : 'KMS Key UUID to rotate', type : 'uuid', length : 255, required : True, related : 'createKMSKey,updateKMSKey'}], response : [{name : 'jobresulttype', description : 'The result type', type : 'string'}, {name : 'account', description : 'The Account that executed the async command', type : 'string'}, {name : 'domainid', description : 'The domain ID that executed the async command', type : 'string'}, {name : 'managementservername', description : 'the management server name of the host', type : 'string'}, {name : 'completed', description : 'The completed date of the job', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'jobprocstatus', description : 'The progress information of the PENDING job', type : 'integer'}, {name : 'jobinstancetype', description : 'The Instance/entity object related to the job', type : 'string'}, {}, {name : 'created', description : 'The created date of the job', type : 'date'}, {name : 'jobresultcode', description : 'The result code for the job', type : 'integer'}, {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 : 'accountid', description : 'The Account ID that executed the async command', type : 'string'}, {name : 'userid', description : 'The User that executed the async command', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'managementserverid', description : 'The MSID of the management server on which the job is running', type : 'string'}, {name : 'domainpath', description : 'The domain that executed the async command', type : 'string'}, {name : 'cmd', description : 'The async command executed', type : 'string'}], httprequesttype : 'POST'}, {name : 'addMemberToInstanceBootGroup', description : 'Adds an Instance or instance group to an instance boot group. Exactly one of virtualmachineid or instancegroupid must be specified.', since : '24.0', isasync : False, related : '', params : [{name : 'virtualmachineid', description : 'The ID of the Instance to add (exclusive with instancegroupid)', 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 : 'instancegroupid', description : 'The ID of the Instance Group to add (exclusive with virtualmachineid)', type : 'uuid', length : 255, required : False, related : ''}, {name : 'id', description : 'The ID of the instance boot group', type : 'uuid', length : 255, required : True, related : 'stopInstanceBootGroup'}, {name : 'order', description : 'The boot order value for this member (0 or greater; non-contiguous values are allowed). Any existing member already at or past this value is shifted one slot later to make room', type : 'integer', length : 255, required : True}], response : [{name : 'bootgroupid', description : 'The ID of the boot group this member belongs to', type : 'string'}, {name : 'readinessmessage', description : "Why readinessstatus is what it is: the failing rule(s)' cached message, and/or a count of not-ready member VMs for InstanceGroup members", type : 'string'}, {name : 'membername', description : 'The name of the VM or InstanceGroup', type : 'string'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'order', description : 'The boot order value for this member', type : 'int'}, {name : 'readinessstatus', description : 'The last cached readiness evaluation', type : 'string'}, {name : 'readinessmode', description : 'None, CHILD_DEPENDENT or RULE_BASED, computed from whether readiness rules are attached', type : 'string'}, {}, {name : 'id', description : 'The UUID of this member entry', type : 'string'}, {name : 'memberstate', description : 'The state of the Instance', type : 'string'}, {name : 'memberid', description : 'The ID of the VM or InstanceGroup', type : 'string'}, {name : 'created', description : 'The date the member was added to the boot group', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'membertype', description : 'The type of the member: VirtualMachine or InstanceGroup', type : 'string'}, {name : 'children', description : 'For InstanceGroup members, the VMs within the group (only present when requested via details=children)', type : 'list'}], httprequesttype : 'POST'}, {name : 'changeSharedFileSystemServiceOffering', description : 'Change Service offering of a Shared FileSystem', since : '4.20.0', isasync : True, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering', params : [{name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering'}, {name : 'serviceofferingid', description : 'the offering to use for the shared filesystem instance', type : 'uuid', length : 255, required : True, related : 'updateServiceOffering,listServiceOfferings'}], response : [{}, {name : 'state', description : 'the state of the shared filesystem', type : 'string'}, {name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'diskioread', description : 'the read (IO) of disk on the shared filesystem', type : 'long'}, {name : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'projectid', description : 'the project ID of the shared filesystem', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'path', description : 'path to mount the shared filesystem', 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 : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', 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 : '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 : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', 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 : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {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 : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', 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 : 'ip6cidr', description : 'The CIDR of IPv6 Network', 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 : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', 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 : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'networkid', description : 'The ID 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 : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'vpcname', description : 'Name of the VPC to which the NIC belongs', type : 'string'}]}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'volumeid', description : 'ID of the storage fs data volume', type : 'string'}, {name : 'iscustomdiskoffering', description : 'disk offering for the shared filesystem has custom size', type : 'boolean'}, {name : 'domainpath', description : 'path of the domain to which 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 : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{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 : 'key', description : 'Tag key name', 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 : 'customer', description : 'Customer 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 : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', type : 'string'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'project', description : 'the project name of the shared filesystem', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}], httprequesttype : 'POST'}, {name : 'cloudianIsEnabled', description : 'Checks if the Cloudian Connector is enabled', since : '4.11.0', isasync : False, related : '', 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 : 'enabled', description : 'The Cloudian connector enabled state', type : 'boolean'}, {name : 'url', description : 'The Cloudian Management Console base URL', type : 'string'}, {}], httprequesttype : 'GET'}, {name : 'copySnapshot', description : 'Copies a snapshot from one zone to another.', since : '4.19.0', isasync : True, related : 'listSnapshots', params : [{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'}, {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 : '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 : 'id', description : 'the ID of the snapshot.', type : 'uuid', length : 255, required : True, related : 'copySnapshot,listSnapshots'}], response : [{name : 'physicalsize', description : 'Physical size of backed up Snapshot on image store', type : 'long'}, {name : 'volumetype', description : 'Type of the disk volume', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'ostypeid', description : 'ID of the os on volume', type : 'string'}, {name : 'locationtype', description : 'Valid location types are primary and secondary.', type : 'string'}, {name : 'status', description : 'the status of the template', type : 'string'}, {name : 'datastoreid', description : 'ID of the datastore for the snapshot entry', type : 'string'}, {name : 'id', description : 'ID of the Snapshot', 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 : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'resourceid', description : 'ID of the resource', 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 : 'account', description : 'The Account 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 : '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 : '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 : 'osdisplayname', description : 'Display name of the os on volume', type : 'string'}, {name : 'project', description : 'The project name of the Snapshot', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'domainid', description : "The domain ID of the Snapshot's Account", type : 'string'}, {name : 'domainpath', description : "path of the Domain the snapshot's account belongs to", type : 'string'}, {name : 'snapshottype', description : 'The type of the Snapshot', 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 disk volume', type : 'string'}, {name : 'parentname', description : 'The parent name of the Snapshot', type : 'string'}, {name : 'revertable', description : 'Indicates whether the underlying storage supports reverting the volume to this Snapshot', type : 'boolean'}, {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 : 'virtualsize', description : 'Virtual size of backedup Snapshot on image store', type : 'long'}, {name : 'downloaddetails', description : 'download progress of a snapshot', type : 'map'}, {name : 'projectid', description : 'The project id of the Snapshot', type : 'string'}, {name : 'name', description : 'Name of the Snapshot', type : 'string'}, {name : 'zonename', description : 'name of the availability zone', type : 'string'}, {}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'volumestate', description : 'state of the disk volume', type : 'string'}, {name : 'volumeid', description : 'ID of the disk volume', type : 'string'}, {name : 'datastorestate', description : 'state of the snapshot on the datastore', type : 'string'}, {}, {name : 'account', description : 'The Account associated with the Snapshot', type : 'string'}, {name : 'domain', description : "The domain name of the Snapshot's Account", type : 'string'}, {name : 'datastoretype', description : 'type of the datastore for the snapshot entry', type : 'string'}, {name : 'intervaltype', description : 'Valid types are hourly, daily, weekly, monthy, Template, and none.', type : 'string'}, {name : 'datastorename', description : 'name of the datastore for the snapshot entry', type : 'string'}], httprequesttype : 'POST'}, {name : 'createDnsRecord', description : 'Creates a DNS record directly on the provider', since : '4.23.0', isasync : True, related : '', params : [{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}, {name : 'type', description : 'DNS record type (e.g., A, AAAA, CNAME, MX, TXT, etc.)', type : 'string', length : 255, required : True}], response : [{name : 'contents', description : 'The contents of the record (IP address or target)', type : 'list'}, {}, {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'}, {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'}], httprequesttype : 'POST'}, {name : 'listSharedFileSystems', description : 'List Shared FileSystems', since : '4.20.0', isasync : False, related : 'changeSharedFileSystemDiskOffering', params : [{name : 'diskofferingid', description : 'the disk offering of the shared filesystem', type : 'uuid', length : 255, required : False, related : ''}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {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 : '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 ID of the shared filesystem', type : 'uuid', length : 255, required : False, related : 'listSharedFileSystems,changeSharedFileSystemDiskOffering'}, {name : 'name', description : 'the name of the shared filesystem', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'the ID of the availability zone', type : 'uuid', length : 255, required : False, related : 'listZones'}, {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 : 'retrieveonlyresourcecount', description : "Makes the API's response contains only the resource count", 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 : 'page', 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 : ''}, {name : 'networkid', description : 'the ID of the network', type : 'uuid', length : 255, required : False, related : 'createNetwork,updateNetwork,listNetworks,migrateNetwork'}, {name : 'serviceofferingid', description : 'the service offering of the shared filesystem', type : 'uuid', length : 255, required : False, related : 'updateServiceOffering,listServiceOfferings'}], response : [{name : 'description', description : 'description of the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', 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 : 'provisioningtype', description : 'provisioning type used in the shared filesystem', 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 : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'diskofferingid', description : 'disk offering ID for the shared filesystem', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{name : 'id', description : 'The ID 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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'ip6address', description : 'The IPv6 address of Network', 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 : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {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 : '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 : '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 : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', 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 : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {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 : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {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 : 'vpcid', description : 'ID of the VPC to which the NIC belongs', 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 : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}]}, {name : 'path', description : 'path to mount the shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', 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 : 'serviceofferingid', description : 'service offering ID for 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 : 'storage', description : 'name of the storage pool hosting the data volume', type : 'string'}, {name : 'tags', description : 'The list of resource tags associated', type : 'set', response : [{name : 'project', description : 'The project name where tag belongs to', 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 : '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 : '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 : 'resourcetype', description : 'Resource type', 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 : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', 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 : '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 : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', 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 : 'serviceofferingname', description : 'service offering for 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 : '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 : '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 : 'privateip', description : 'The private IP address for the System VM', type : 'string'}, {name : 'linklocalip', description : 'The Control IP address for the System VM', type : 'string'}, {name : 'networkdomain', description : 'The Network domain for the System VM', type : 'string'}, {name : 'version', description : 'The systemvm agent version', 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 : 'serviceofferingname', description : 'the name of the service offering of the system virtual machine.', type : 'string'}, {name : 'linklocalmacaddress', description : 'The link local MAC address for the System VM', type : 'string'}, {name : 'templateid', description : 'The Template ID for the System VM', type : 'string'}, {name : 'zoneid', description : 'The Zone 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 : '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 : 'gateway', description : 'The gateway 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 : 'hostname', description : 'The hostname for the System VM', type : 'string'}, {name : 'publicmacaddress', description : 'The public MAC address 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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'guestvlan', description : 'Guest VLAN range', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {}, {name : 'created', description : 'The date and time the System VM was created', type : 'date'}, {name : 'templatename', description : 'The Template name for the System VM', type : 'string'}, {name : 'podid', description : 'The Pod ID 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 : 'podname', description : 'The Pod name for the System VM', type : 'string'}, {}, {name : 'systemvmtype', description : 'The System VM type', type : 'string'}, {name : 'state', description : 'The state of the System VM', type : 'string'}, {name : 'serviceofferingid', description : 'the ID of the service offering of the system virtual machine.', type : 'string'}, {name : 'privatenetmask', description : 'The private netmask for the System VM', type : 'string'}, {name : 'hostid', description : 'The host ID for the System VM', type : 'string'}, {name : 'privatemacaddress', description : 'The private MAC address for the System VM', type : 'string'}, {name : 'dns2', description : 'The second DNS for the System VM', type : 'string'}, {name : 'zonename', description : 'The Zone name for the System VM', type : 'string'}, {name : 'agentstate', description : 'The agent state of the System VM', type : 'string'}, {name : 'linklocalnetmask', description : 'The link local netmask for the System VM', type : 'string'}, {name : 'arch', description : 'CPU arch of the system VM', type : 'string'}, {name : 'id', description : 'The ID of 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 : '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 : 'format', description : 'The format for the Template. Possible values include QCOW2, RAW, VHD and OVA.', type : 'string', length : 255, required : True}, {name : 'account', description : 'An optional accountName. Must be used with domainId.', type : 'string', 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 : '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 : 'bits', description : '32 or 64 bits support. 64 by default', type : 'integer', 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 : 'passwordenabled', description : 'True if the Template supports the password reset feature; default is false', type : 'boolean', 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 : 'displaytext', description : "The display text of the Template, defaults to 'name'.", type : 'string', length : 4096, 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 : '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 : '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 : 'directdownload', description : 'True if Template should bypass Secondary Storage and be downloaded to Primary Storage on deployment', type : 'boolean', length : 255, required : False}, {name : 'extensionid', description : 'ID of the extension', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listExtensions'}, {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 : '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 : 'projectid', description : 'Register Template for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'url', description : 'The URL of where the Template is hosted. Possible URL include http:// and https://', type : 'string', length : 2048, required : True}, {name : 'ispublic', description : 'True if the Template is available to all accounts; default is true', type : 'boolean', 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 : '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 : 'forcks', description : 'if true, the templates would be available for deploying CKS clusters', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'name', description : 'The name of 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.19.0'}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean', length : 255, required : False}, {name : 'hypervisor', description : 'The target hypervisor for the Template', type : 'string', length : 255, required : True}, {name : 'requireshvm', description : 'True if this Template requires HVM', type : 'boolean', length : 255, required : False}, {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'}], response : [{name : 'displaytext', description : 'The Template display text', type : 'string'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {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 : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'requireshvm', description : 'True if Template requires HVM enabled, false otherwise', type : 'boolean'}, {}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', type : 'boolean'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {name : 'isready', description : 'True if the Template is ready to be deployed from, false otherwise.', type : 'boolean'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'bits', description : 'The processor bit size', type : 'int'}, {name : 'accountid', description : 'The Account id to which the Template belongs', type : 'string'}, {name : 'crossZones', description : 'True if the Template is managed across all Zones, false otherwise', type : 'boolean'}, {name : 'ispublic', description : 'True if this Template is a public Template, false otherwise', type : 'boolean'}, {name : 'account', description : 'The Account name to which the Template belongs', type : 'string'}, {name : 'status', description : 'The status of the Template', type : 'string'}, {name : 'id', description : 'The Template ID', type : 'string'}, {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 : 'removed', description : 'The date this Template was removed', type : 'date'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'url', description : 'The URL which the Template/ISO is registered from', type : 'string'}, {name : 'checksum', description : 'Checksum of the Template', type : 'string'}, {name : 'parenttemplateid', description : 'If Datadisk Template, then id of the root disk Template this Template belongs to', type : 'string'}, {name : 'extensionid', description : 'The ID of extension linked to this template', type : 'string'}, {name : 'templatetype', description : 'The type of the Template', type : 'string'}, {name : 'sshkeyenabled', description : 'True if Template is sshkey enabled, false otherwise', type : 'boolean'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'userdataname', description : 'The name of userdata linked to this Template', type : 'string'}, {name : 'userdataid', description : 'The id of userdata linked to this Template', type : 'string'}, {name : 'name', description : 'The Template name', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'sourcetemplateid', description : 'The Template ID of the parent Template if present', type : 'string'}, {name : 'passwordenabled', description : 'True if the reset password feature is enabled, false otherwise', type : 'boolean'}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'ostypeid', description : 'The ID of the OS type for this Template.', type : 'string'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'isextractable', description : 'True if the Template is extractable, false otherwise', type : 'boolean'}, {name : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {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 : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean'}, {}, {name : 'zonename', description : 'The name of the zone for this Template', type : 'string'}, {name : 'templatetag', description : 'The tag of this Template', type : 'string'}, {name : 'hostid', description : 'The ID of the secondary storage host for the Template', type : 'string'}, {name : 'domain', description : 'The name of the domain to which the Template belongs', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying 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 : '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 : '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 : '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 : 'hostname', description : 'The name of the secondary storage host for the Template', type : 'string'}, {name : 'size', description : 'The size of the Template', type : 'long'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'project', description : 'The project name 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 : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', type : 'string'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listVirtualMachinesUsageHistory', description : 'Lists VM stats', since : '4.17', isasync : False, related : 'listSystemVmsUsageHistory', params : [{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 : '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 : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {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 : '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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{}, {}, {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 : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'stats', description : 'The list of Instance stats', type : 'list', response : [{name : 'memorytargetkbs', description : 'The target memory in Instance (KB)', type : 'long'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'memorykbs', description : 'The memory used by the Instance in KB', type : 'long'}, {name : 'cpuused', description : "The amount (percentage) of the Instance's CPU currently used", type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'networkwrite', description : 'The amount of uploaded data by the Instance in MiB', type : 'string'}, {name : 'memoryintfreekbs', description : "The Instance's free memory in KB or -1 if it cannot be gathered", type : 'long'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host 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 : 'networkread', description : 'The amount of downloaded data by the Instance in MiB', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {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 : 'diskiopstotal', description : 'The total disk IOPS since the last stats retrieval', type : 'long'}]}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'createKubernetesCluster', description : 'Creates a Kubernetes cluster', isasync : True, related : 'startKubernetesCluster,updateKubernetesClusterAffinityGroups', params : [{name : 'asnumber', description : 'the AS Number of the network', type : 'long', length : 255, required : False}, {name : 'externalloadbalanceripaddress', description : 'External load balancer IP address while using shared network with Kubernetes HA 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 : '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 : 'dockerregistryurl', description : 'URL for the docker image private registry', type : 'string', 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 : 'noderootdisksize', description : 'Root disk size in GB for each node', 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 : 'controlnodes', description : 'Number of Kubernetes cluster control nodes, default is 1', type : 'long', length : 255, required : False}, {name : 'dockerregistryusername', description : 'User name for the docker image private registry', 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. Example: nodetemplates[0].node='control'&nodetemplates[0].template='<template-uuid>'&nodetemplates[1].node='worker'&nodetemplates[1].template='<template-uuid>'", type : 'map', length : 255, required : False, since : '4.21.0'}, {name : 'dockerregistrypassword', description : 'Password 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 : 'keypair', description : 'Name of the SSH key pair used to login to the Instances', type : 'string', length : 255, required : False}, {name : 'description', description : 'Description for the Kubernetes cluster', type : 'string', 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'}, {name : 'name', description : 'Name for the Kubernetes cluster', type : 'string', length : 255, required : True}, {name : 'cniconfigurationid', description : 'the ID of the Userdata', type : 'uuid', length : 255, required : False, since : '4.21.0', related : ''}, {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 : 'account', description : 'An optional Account for the Instance. Must be used with domainId.', type : 'string', length : 255, required : False}, {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 : '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 : '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 : 'size', description : 'Number of Kubernetes cluster worker nodes', type : 'long', length : 255, required : False}, {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 : 'projectid', description : 'Deploy cluster for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'nodeofferings', description : "(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter. Example: nodeofferings[0].node='control'&nodeofferings[0].offering='<service-offering-uuid>'&nodeofferings[1].node='worker'&nodeofferings[1].offering='<service-offering-uuid>'", type : 'map', 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'}], response : [{name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'templateid', description : 'The ID of the Template 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 : '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 : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {}, {name : 'zonename', description : 'The name of the zone 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 : 'serviceofferingid', description : 'The ID of the service offering 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 : 'controlofferingid', description : 'the ID 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 : 'state', description : 'The state 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 : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', 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 : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', type : 'string'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'etcdofferingid', description : 'the ID of the service offering of the etcd nodes on the Kubernetes cluster', 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 : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'size', description : 'The size (worker nodes count) of 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 : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on the Kubernetes cluster', type : 'string'}, {name : 'project', description : 'The project name 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 : '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'}, {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 : '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 : ''}], response : [{name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'account', description : 'The account owning the affinity group', type : 'string'}, {name : 'description', description : 'The description of the affinity group', type : 'string'}, {name : 'domain', description : 'The domain name of the affinity group', type : 'string'}, {name : 'project', description : 'The project name of the affinity group', type : 'string'}, {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 : '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 : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}]}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', 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 : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {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 : 'group', description : 'The group name of the Instance', type : 'string'}, {}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'cpuspeed', description : 'The speed of each vCPU', type : 'integer'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Instance', type : 'string'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'state', description : 'The state 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 : 'bootmode', description : 'Guest Instance Boot Mode', 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 : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {}, {name : 'userdataname', description : 'The name of userdata used for the Instance', type : 'string'}, {}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {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 : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {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', type : 'set', response : [{name : 'value', description : 'Tag value', 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 : '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 : '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 : 'resourceid', description : 'ID of the resource', type : 'string'}]}, {name : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', 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 : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', 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 : '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 : 'name', description : 'The name of the attached ISO', type : 'string'}]}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', 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 : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {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 : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'gpucardid', description : 'the ID of the gpu card 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 : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {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 : '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 : 'description', description : 'The description of the security 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 : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{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 : 'domain', description : '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 : 'resourceid', description : 'ID of the resource', 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 : 'projectid', description : 'The project ID the tag belongs to', 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 : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'domain', description : 'The domain name of the security group', type : 'string'}, {name : 'ingressrule', description : 'The list of ingress rules associated with the security group', type : 'set', response : [{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 : 'protocol', description : 'The protocol 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 : '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 : '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 : 'key', description : 'Tag key name', 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 : 'domainpath', description : 'Path of 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 : '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 : 'icmptype', description : 'The type of the ICMP message response', type : 'integer'}, {name : 'securitygroupname', description : 'Security group name', 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 : '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 : '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 : '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 : 'project', description : 'The project name where tag belongs to', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}]}, {name : 'startport', description : 'The starting IP of the security group rule', type : 'integer'}, {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 : 'account', description : 'Account owning 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 : '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 : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {name : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'macaddress', description : 'True if NIC is default, false otherwise', 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 : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'vpcid', description : 'ID of the VPC to which the NIC belongs', 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 : '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 : 'deviceid', description : 'Device ID for the Network when plugged into the Instance', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'nicdnsname', description : "DNS name associated with this NIC's IP address", type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', 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 : '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 : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {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 : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {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 : 'isdefault', description : 'True if NIC is default, false otherwise', type : 'boolean'}, {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 : 'netmask', description : 'The netmask of the NIC', type : 'string'}]}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', 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 : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {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 : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'domainpath', description : 'Path of the domain in which the virtual machine exists', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {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 : 'POST'}, {name : 'updateWebhook', description : 'Updates a Webhook', since : '4.20.0', isasync : False, related : 'createWebhook', params : [{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 : 'scope', description : 'Scope of the Webhook', type : 'string', length : 255, required : False}, {name : 'payloadurl', description : 'Payload URL of the Webhook', type : 'string', length : 255, required : False}, {name : 'name', description : 'Name for 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'}, {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 : 'description', description : 'Description for the Webhook', type : 'string', length : 255, required : False}], response : [{name : 'created', description : 'The date when this Webhook was created', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {name : 'secretkey', description : 'The secret key for 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 : 'domain', description : 'The name of the domain in which the Webhook exists', type : 'string'}, {name : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'project', description : 'the project name of the Kubernetes cluster', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', 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'}, {}, {name : 'account', description : 'The account associated with the Webhook', type : 'string'}, {}, {name : 'description', description : 'The description of the Webhook', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}], 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 : 'certificate', description : 'The client certificate', type : 'string'}, {}, {name : 'privatekey', description : 'Private key for the certificate', type : 'string'}, {name : 'cacertificates', description : 'The CA certificate(s)', 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 : 'updateProjectRole', description : 'Creates a Project role', since : '4.15.0', isasync : False, related : '', params : [{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 : 'projectid', description : 'ID of project where role is being created', type : 'uuid', length : 255, required : True, related : ''}, {name : 'name', description : 'Creates a project role with this unique name', type : 'string', length : 255, required : False}], response : [{name : 'description', description : 'The description 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 : 'projectid', description : 'The ID of the project', type : 'string'}, {name : 'id', description : 'The ID of the role', type : 'string'}, {}, {}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', 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 : 'accountid', description : 'the ID of the Account', type : 'uuid', length : 255, required : False, related : 'enableAccount,listAccounts'}, {name : 'convertinstancehostid', description : 'Conversion host of the importing task', type : 'uuid', length : 255, required : False, related : 'reconnectHost'}, {name : 'tasksfilter', description : 'Filter tasks by state, valid options are: All, Running, Completed, Failed', type : 'string', 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 : '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 : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}], response : [{name : 'convertinstancehostname', description : 'the name of the host on which the instance is being converted', type : 'string'}, {name : 'step', description : 'the current step on the importing VM task', type : 'string'}, {name : 'convertinstancehostid', description : 'the ID of the host on which the instance is being converted', type : 'string'}, {name : 'stepduration', description : 'the duration of the current step', type : 'string'}, {name : 'created', description : 'the create date of the importing task', type : 'date'}, {name : 'zonename', description : 'the Zone name', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'sourcevmname', description : 'the source VM name', type : 'string'}, {name : 'displayname', description : 'the display name of the importing VM', type : 'string'}, {name : 'duration', description : 'the total task duration', type : 'string'}, {name : 'id', description : 'the ID of importing task', type : 'string'}, {name : 'accountid', description : 'the ID of account', type : 'string'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'datacentername', description : 'the datacenter name of the importing VM task', type : 'string'}, {name : 'description', description : 'the current step description on the importing VM task', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {name : 'zoneid', description : 'the Zone ID', type : 'string'}, {name : 'vcenter', description : 'the vcenter name of the importing VM task', type : 'string'}, {}, {name : 'virtualmachineid', description : 'the ID of the imported VM (after task is completed)', type : 'string'}, {name : 'state', description : 'the state of the importing VM task', type : 'string'}, {name : 'lastupdated', description : 'the last updated date of the importing task', type : 'date'}], httprequesttype : 'GET'}, {name : 'createKMSKey', description : 'Creates a new KMS key (Key Encryption Key) for encryption', since : '4.23.0', isasync : False, related : 'updateKMSKey', params : [{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 : '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 : 'name', description : 'Name of the KMS key', type : 'string', length : 255, required : True}, {name : 'projectid', description : 'ID of the project to create the KMS key for', type : 'uuid', length : 255, required : False, related : ''}, {name : 'zoneid', description : 'Zone ID where the key will be valid', type : 'uuid', length : 255, required : True, related : 'listZones'}], response : [{name : 'version', description : 'the key size in bits', type : 'integer'}, {name : 'hsmprofile', description : 'the zone name where the key is valid', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'hsmprofileid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'keybits', description : 'the key size in bits', type : 'integer'}, {name : 'id', description : 'the UUID of the key', type : 'string'}, {}, {name : 'project', description : 'the project name of the key', type : 'string'}, {name : 'accountid', description : 'the account ID owning the key', type : 'string'}, {name : 'domainid', description : 'the domain ID of the key', type : 'string'}, {name : 'zonename', description : 'the zone name where the key is valid', type : 'string'}, {name : 'description', description : 'the description of the key', type : 'string'}, {name : 'zoneid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'created', description : 'the creation timestamp', type : 'date'}, {}, {name : 'projectid', description : 'the project ID of the key', type : 'string'}, {name : 'algorithm', description : 'the encryption algorithm', type : 'string'}, {name : 'account', description : 'the account owning the key', type : 'string'}, {name : 'domain', description : 'the domain name of the key', type : 'string'}, {name : 'domainpath', description : 'the domain path of the key', 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 key', type : 'string'}, {name : 'enabled', description : 'whether the key is enabled', type : 'boolean'}, {name : 'keklabel', description : 'the provider-specific KEK label (admin only)', type : 'string'}], httprequesttype : 'POST'}, {name : 'changeSharedFileSystemDiskOffering', description : 'Change Disk offering of a Shared FileSystem', since : '4.20.0', isasync : True, related : '', params : [{name : 'miniops', description : 'min iops', type : 'long', length : 255, required : False}, {name : 'id', description : 'the ID of the shared filesystem', type : 'uuid', length : 255, required : True, related : 'changeSharedFileSystemDiskOffering'}, {name : 'size', description : 'the size of the shared filesystem in GiB', type : 'long', length : 255, required : False}, {name : 'maxiops', description : 'max iops', 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 : ''}], response : [{name : 'id', description : 'ID of the shared filesystem', type : 'string'}, {name : 'diskkbswrite', description : "the shared filesystem's disk write in KiB", type : 'long'}, {}, {name : 'sizegb', description : 'size of the shared filesystem in GiB', type : 'string'}, {name : 'utilization', description : 'the disk utilization', type : 'string'}, {name : 'virtualmachineid', description : 'ID of the storage fs vm', type : 'string'}, {name : 'domainid', description : 'the ID of the domain associated with the shared filesystem', type : 'string'}, {name : 'account', description : 'the account associated with the shared filesystem', type : 'string'}, {}, {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 : 'diskofferingdisplaytext', description : 'disk offering display text for the shared filesystem', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {name : 'nic', description : 'the list of nics associated with the shared filesystem', type : 'list', response : [{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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'mtu', description : 'MTU configured on the NIC', type : 'integer'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', 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 : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'virtualmachineid', description : 'Id of the Instance to which the NIC belongs', 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 : '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 : 'nsxlogicalswitchport', description : 'Id of the NSX Logical Switch Port (if NSX based), null otherwise', type : 'string'}, {name : 'networkname', description : 'The name of the corresponding Network', 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 : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'networkid', description : 'The ID of the corresponding Network', 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 : 'enabled', description : 'whether the NIC is enabled or not', type : 'boolean'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', 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 : 'gateway', description : 'The gateway of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', type : 'string'}, {name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}]}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'diskiowrite', description : 'the write (IO) of disk on the shared filesystem', type : 'long'}, {name : 'serviceofferingname', description : 'service offering for the shared filesystem', type : 'string'}, {name : 'storageid', description : 'ID of the storage pool hosting the data volume', type : 'string'}, {name : 'provider', description : 'the shared filesystem provider', 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 : 'domain', description : 'The domain associated with the tag', 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 : '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 : 'diskofferingid', description : 'disk offering ID for the shared filesystem', 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 shared filesystem', type : 'string'}, {name : 'filesystem', description : 'the filesystem format', 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 : 'projectid', description : 'the project ID of 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 : 'networkid', description : 'Network ID of the shared filesystem', type : 'string'}, {name : 'physicalsize', description : 'the bytes actually consumed on disk', type : 'long'}, {name : 'diskofferingname', description : 'disk offering for the shared filesystem', type : 'string'}, {name : 'networkname', description : 'Network name of the shared filesystem', type : 'string'}, {name : 'name', description : 'name of the shared filesystem', type : 'string'}, {name : 'serviceofferingid', description : 'service offering ID for the shared filesystem', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'vmstate', description : 'ID of the storage fs vm', type : 'string'}, {name : 'provisioningtype', description : 'provisioning type used in the shared filesystem', type : 'string'}, {name : 'virtualsize', description : 'the bytes allocated', type : 'long'}, {name : 'domain', description : 'the domain associated with the shared filesystem', type : 'string'}, {name : 'size', description : 'size of the shared filesystem', type : 'long'}, {name : 'volumename', description : 'name of the storage fs 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 : 'diskkbsread', description : "the shared filesystem's disk read in KiB", type : 'long'}], httprequesttype : 'POST'}, {name : 'stopInstanceBootGroup', description : 'Stops all Instances in an Instance Boot Group in reverse order (highest boot order first). Continues through all tiers even if some Instances fail to stop', since : '24.0', isasync : True, related : '', params : [{name : 'forced', description : 'Force stop every Instance in the Instance Boot Group (marked as Stopped even when the stop command fails to be sent to the backend, otherwise a force poweroff is attempted)', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The ID of the Instance Boot Group', type : 'uuid', length : 255, required : True, related : 'stopInstanceBootGroup'}], response : [{}, {name : 'domain', description : 'The domain name of the instance boot group', type : 'string'}, {name : 'readinessattempttimeoutseconds', description : 'Effective timeout in seconds for each readiness retry attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'created', description : 'The date the instance boot group was created', type : 'date'}, {name : 'projectid', description : 'The project ID of the instance boot group', type : 'string'}, {name : 'accountid', description : 'The account ID owning the instance boot group', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'readinessrebootonretry', description : 'Effective setting for whether an instance is rebooted between readiness retry attempts (per-boot-group override if set, else the global default)', type : 'boolean'}, {name : 'id', description : 'The ID of the instance boot group', type : 'string'}, {name : 'domainpath', description : 'The path of the domain the instance boot group belongs to', type : 'string'}, {name : 'domainid', description : 'The domain ID of the instance boot group', type : 'string'}, {name : 'account', description : 'The account owning the instance boot group', type : 'string'}, {name : 'readinessmaxretryattempts', description : 'Effective maximum number of readiness retry attempts (per-boot-group override if set, else the global default)', type : 'long'}, {}, {name : 'readinessinitialdelayseconds', description : 'Effective delay in seconds after starting or rebooting an instance before its first readiness check of that attempt (per-boot-group override if set, else the global default)', type : 'long'}, {name : 'name', description : 'The name of the instance boot group', type : 'string'}, {name : 'project', description : 'The project name of the instance boot group', 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 instance boot group', 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 : '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 : 'getUploadParamsForTemplate', description : 'Upload an existing Template into the CloudStack cloud. ', since : '4.6.0', isasync : False, related : 'getUploadParamsForIso', params : [{name : 'displaytext', description : 'The display text of the Template. This is usually used for display purposes.', type : 'string', length : 4096, required : False}, {name : 'isfeatured', description : 'True if this Template is a featured Template, false otherwise', 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 : '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 : 'templatetag', description : 'The tag for this Template.', type : 'string', 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 : 'name', description : 'The name of the Volume/Template/ISO', type : 'string', length : 255, required : True}, {name : 'account', description : 'An optional accountName. Must be used with domainId.', type : 'string', 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 : 'ispublic', description : 'True if the Template is available to all accounts; default is true', 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 : 'requireshvm', description : 'True if this Template requires HVM', type : 'boolean', 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 : '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 : 'bits', description : '32 or 64 bits support. 64 by default', type : 'integer', length : 255, required : False}, {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 : 'sshkeyenabled', description : 'True if the Template supports the SSHkey upload feature; default is false', type : 'boolean', 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 : '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 : 'isextractable', description : 'True if the Template 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 : 'details', description : 'Template details in key/value pairs.', type : 'map', length : 255, required : False}, {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}], response : [{name : 'postURL', description : 'POST url to upload the file to', type : 'url'}, {name : 'signature', description : 'Signature to be sent in the POST request.', 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 : 'id', description : 'The Template/volume ID', type : 'uuid'}, {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'}, {}], httprequesttype : 'GET'}, {name : 'listAutoScaleVmProfiles', description : 'Lists autoscale Instance profiles.', isasync : False, related : '', params : [{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 : '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 : '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 : '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 : '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 : '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 : 'otherdeployparams', description : 'The otherdeployparameters of the autoscale Instance profile', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the autoscale Instance profile', type : 'uuid', length : 255, required : False, related : 'listAutoScaleVmProfiles'}, {name : 'projectid', description : 'List objects by project; if projectid=-1 lists All Instances', type : 'uuid', length : 255, required : False, related : ''}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {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'}], response : [{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 : 'id', description : 'The autoscale Instance profile ID', type : 'string'}, {name : 'autoscaleuserid', description : 'The ID of the User used to launch and destroy the Instances', type : 'string'}, {name : 'project', description : 'The project name of the Instance profile', type : 'string'}, {name : 'userdatapolicy', description : 'the userdata override policy with the userdata provided while deploying VM', type : 'string'}, {name : 'domain', description : 'The domain name of the Instance profile', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', 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'}, {name : 'userdataname', description : 'the name of userdata used for the VM', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the vm profile belongs', type : 'string'}, {name : 'templateid', description : 'The Template to be used while deploying an Instance', type : 'string'}, {}, {name : 'userdata', description : 'Base64 encoded Instance user data', type : 'string'}, {}, {name : 'zoneid', description : 'The availability zone to be used while deploying an Instance', type : 'string'}, {name : 'expungevmgraceperiod', description : 'The time allowed for existing connections to get closed before an Instance is destroyed', type : 'integer'}, {name : 'fordisplay', description : 'Is profile for display to the regular User', type : 'boolean'}, {name : 'account', description : 'The Account owning the Instance group', type : 'string'}, {name : 'domainid', description : 'The domain ID of the Instance profile', type : 'string'}, {name : 'userdataid', description : 'the id of userdata used for the VM', type : 'string'}, {name : 'otherdeployparams', description : 'Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance', type : 'map'}], httprequesttype : 'GET'}, {name : 'updateBucket', description : 'Updates Bucket properties', since : '4.19.0', isasync : False, params : [{name : 'versioning', description : 'Enable/Disable Bucket Versioning', type : 'boolean', length : 255, required : False}, {name : 'id', description : 'The ID of the Bucket', type : 'uuid', length : 255, required : True, related : ''}, {name : 'quota', description : 'Bucket Quota in GiB', type : 'integer', length : 255, required : False}, {name : 'policy', description : 'Bucket Access Policy', type : 'string', length : 255, required : False}, {name : 'encryption', description : 'Enable/Disable Bucket encryption', type : 'boolean', length : 255, required : False}], 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 : '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 : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}, {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'}, {}], 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 : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'page', description : '', type : 'integer', 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'}], response : [{}, {}, {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'}, {name : 'zonename', description : 'Tungsten-Fabric provider zone name', type : 'string'}, {name : 'uuid', description : 'Tungsten-Fabric nic uuid', type : 'string'}, {name : 'zoneid', description : 'Tungsten-Fabric provider zone id', type : 'long'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}], 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 : '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 : 'secretkey', description : 'Secret key of the Webhook', type : 'string', length : 255, required : False}, {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 : ''}, {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 : 'sslverification', description : 'If set to true then SSL verification will be done for the Webhook otherwise not', type : 'boolean', length : 255, required : False}, {name : 'scope', description : 'Scope of the Webhook', type : 'string', length : 255, required : False}, {name : 'payloadurl', description : 'Payload URL of the Webhook', type : 'string', length : 255, required : True}], response : [{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 : 'domain', description : 'The name of the domain in which the Webhook exists', type : 'string'}, {name : 'secretkey', description : 'The secret key for the Webhook', type : 'string'}, {name : 'name', description : 'The name of the Webhook', type : 'string'}, {name : 'payloadurl', description : 'The payload URL end point for the Webhook', type : 'string'}, {name : 'sslverification', description : 'Whether SSL verification is enabled for the Webhook', type : 'boolean'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'account', description : 'The account associated with the Webhook', type : 'string'}, {name : 'state', description : 'The state of the Webhook', type : 'string'}, {name : 'domainpath', description : 'path of the domain to which the Webhook belongs', type : 'string'}, {name : 'project', description : 'the project name of the Kubernetes cluster', type : 'string'}, {name : 'id', description : 'The ID of the Webhook', type : 'string'}, {name : 'scope', description : 'The scope of the Webhook', type : 'string'}, {}, {name : 'projectid', description : 'the project id of the Kubernetes cluster', 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'}], 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 : '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'}, {name : 'id', description : 'The ID of the Kubernetes cluster', type : 'uuid', length : 255, required : True, related : 'startKubernetesCluster,updateKubernetesClusterAffinityGroups'}], response : [{name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'kubernetesversionid', description : 'The ID of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', 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 : 'project', description : 'The project name of the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {name : 'controlofferingid', description : 'the ID of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zoneid', description : 'The name of the zone 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 : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for 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 : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'autoscalingenabled', description : 'Whether autoscaling is enabled for the cluster', type : 'boolean'}, {name : 'networkid', description : 'The ID of the network of the Kubernetes cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', type : 'string'}, {name : 'cpunumber', description : 'The cpu cores of the Kubernetes cluster', type : 'string'}, {name : 'workeraffinitygroupnames', description : 'The names of affinity groups associated with worker nodes', type : 'string'}, {name : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}, {name : 'size', description : 'The size (worker nodes count) of the Kubernetes cluster', type : 'long'}, {name : 'workeraffinitygroupids', description : 'The IDs of affinity groups associated with worker nodes', type : 'string'}, {name : 'minsize', description : 'Minimum size of the cluster', type : 'long'}, {name : 'cniconfigurationid', description : 'ID of CNI Configuration associated with the cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'memory', description : 'The memory the Kubernetes cluster', type : 'string'}, {name : 'clustertype', description : 'The type of the cluster', type : 'clustertype'}, {name : 'zonename', description : 'The name of the zone 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 : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'controlaffinitygroupnames', description : 'The names 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 : 'name', description : 'The name 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 : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'account', description : 'The Account associated with the Kubernetes cluster', type : 'string'}, {}, {name : 'serviceofferingid', description : 'The ID of the service offering 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 : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'ipaddress', description : 'Public IP Address of the cluster', type : 'string'}, {name : 'virtualmachines', description : 'The list of virtualmachines associated with this Kubernetes cluster', type : 'list'}, {name : 'projectid', description : 'The project id of the Kubernetes cluster', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Kubernetes cluster exists', type : 'string'}, {name : 'templateid', description : 'The ID of the Template of the Kubernetes cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', 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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}], 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 : 'id', description : 'ID of the schedule to be deleted', type : 'uuid', length : 255, required : False, related : ''}, {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}], 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 : 'listKubernetesSupportedVersions', description : 'Lists supported Kubernetes version', isasync : False, related : 'getUploadParamsForKubernetesSupportedVersion', params : [{name : 'page', description : '', type : 'integer', length : 255, required : False}, {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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the Kubernetes supported version', type : 'uuid', length : 255, required : False, related : 'getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions'}, {name : 'minimumkubernetesversionid', description : 'The ID of the minimum Kubernetes supported version', type : 'uuid', length : 255, required : False, related : 'getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions'}, {name : 'pagesize', description : '', type : 'integer', 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 : 'zonename', description : 'The name of the zone in which Kubernetes supported version is available', type : 'string'}, {name : 'zoneid', description : 'The ID of the zone in which Kubernetes supported version is available', type : 'string'}, {name : 'isoid', description : 'The ID of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'isourl', description : 'the URL of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'mincpunumber', description : 'The minimum number of CPUs needed for the Kubernetes supported version', type : 'integer'}, {name : 'supportsautoscaling', description : 'Whether Kubernetes supported version supports Autoscaling', type : 'boolean'}, {name : 'name', description : 'Name of the Kubernetes supported version', type : 'string'}, {name : 'supportsha', description : 'Whether Kubernetes supported version supports HA, multi-control nodes', type : 'boolean'}, {name : 'minmemory', description : 'The minimum RAM size in MB needed for the Kubernetes supported version', type : 'integer'}, {}, {name : 'id', description : 'The ID of the Kubernetes supported version', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes supported version was created', type : 'date'}, {}, {name : 'isoname', description : 'The name of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'isostate', description : 'The state of the binaries ISO for Kubernetes supported version', type : 'string'}, {name : 'state', description : 'The enabled or disabled state of the Kubernetes supported version', type : 'string'}, {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 : 'semanticversion', description : 'Kubernetes semantic version', type : 'string'}, {name : 'arch', description : 'the arch 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'}], httprequesttype : 'GET'}, {name : 'checkVmwareCbtMigrationPrerequisites', description : 'Check whether a VMware VM and KVM destination are ready for VMware CBT based migration', since : '4.24.0', isasync : False, related : '', params : [{name : 'clustername', description : 'the source VMware cluster name', type : 'string', length : 255, required : False}, {name : 'details', description : 'optional service offering custom parameters and migration details', type : 'map', length : 255, required : False}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'uuid', length : 255, required : True, related : 'addCluster'}, {name : 'vcenter', description : 'the source vCenter IP address or FQDN', type : 'string', length : 255, required : False}, {name : 'convertinstancepoolid', description : 'optional primary storage pool for converted disks', type : 'uuid', length : 255, required : False, related : 'cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance'}, {name : 'convertinstancehostid', description : 'optional KVM host to perform CBT block replication', type : 'uuid', length : 255, required : False, related : 'reconnectHost'}, {name : 'datacentername', description : 'the source VMware datacenter name', type : 'string', length : 255, required : False}, {name : 'hostip', description : 'the source VMware ESXi host IP address or FQDN', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'the destination zone ID', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string', length : 255, required : True}, {name : 'existingvcenterid', description : 'UUID of a linked existing vCenter', type : 'uuid', length : 255, required : False, related : ''}, {name : 'serviceofferingid', description : 'optional service offering to validate against the source VM CPU and memory requirements', type : 'uuid', length : 255, required : False, related : 'updateServiceOffering,listServiceOfferings'}, {name : 'username', description : 'the username for the source vCenter', type : 'string', length : 255, required : False}, {name : 'password', description : 'the password for the source vCenter', type : 'string', length : 255, required : False}], response : [{name : 'storagewritertype', description : 'the VMware CBT target storage writer type', type : 'string'}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'string'}, {name : 'sourcecpunumber', description : 'source VMware VM CPU count', type : 'integer'}, {name : 'convertinstancepoolid', description : 'the destination storage pool ID', type : 'string'}, {name : 'sourcecpuspeed', description : 'source VMware VM CPU reservation in MHz used for offering validation, when available', type : 'integer'}, {name : 'convertinstancehostid', description : 'the KVM host selected for conversion and CBT replication', type : 'string'}, {name : 'sourceguestos', description : 'source VMware VM guest OS name', type : 'string'}, {name : 'zonename', description : 'the destination zone name', type : 'string'}, {name : 'sourcememory', description : 'source VMware VM memory in MB', type : 'integer'}, {name : 'ready', description : 'whether the source VM and destination are ready for VMware CBT migration start', type : 'boolean'}, {name : 'convertinstancehostinplacefinalizationsupported', description : 'whether the selected KVM host reports VMware CBT in-place finalization support', type : 'boolean'}, {name : 'datacentername', description : 'the source VMware datacenter', type : 'string'}, {name : 'storagerequiresinplacefinalization', description : 'whether the target storage writer requires virt-v2v in-place finalization', type : 'boolean'}, {name : 'existingsnapshotcount', description : 'number of existing VMware snapshots on the source VM', type : 'integer'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'storagepooltype', description : 'the destination storage pool type', type : 'string'}, {name : 'sourcevmmor', description : 'the source VMware VM managed object reference', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'poolname', description : 'the destination storage pool name', type : 'string'}, {name : 'finding', description : 'preflight findings', type : 'list'}, {name : 'changetrackingsupported', description : 'whether the source VM reports CBT support', type : 'boolean'}, {name : 'disk', description : 'source VMware disk preflight information', type : 'list'}, {}, {name : 'convertinstancehostname', description : 'the KVM host selected for conversion and CBT replication', type : 'string'}, {name : 'sourcehost', description : 'the source VMware ESXi host', type : 'string'}, {name : 'sourceguestosid', description : 'source VMware VM guest OS identifier', type : 'string'}, {name : 'clustername', description : 'the destination KVM cluster name', type : 'string'}, {name : 'storagewritersupported', description : 'whether the target storage writer is implemented', type : 'boolean'}, {name : 'vcenter', description : 'the source VMware vCenter', type : 'string'}, {name : 'noninplacefinalizationfallbacksupported', description : 'whether the selected target storage can use non-in-place fallback finalization', type : 'boolean'}, {name : 'noninplacefinalizationfallbackallowed', description : 'whether VMware CBT non-in-place fallback finalization is enabled by configuration', type : 'boolean'}, {name : 'consolidationneeded', description : 'whether the source VM reports disk consolidation is needed', type : 'boolean'}, {name : 'changetrackingenabled', description : 'whether CBT is currently enabled on the source VM', type : 'boolean'}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string'}, {name : 'zoneid', description : 'the destination zone ID', type : 'string'}, {}], httprequesttype : 'POST'}, {name : 'cutoverVmwareCbtMigration', description : 'Perform final cutover for a VMware CBT migration', since : '4.24.0', isasync : True, related : 'listVmwareCbtMigrations,cancelVmwareCbtMigration', params : [{name : 'password', description : 'optional password override for the source vCenter. Stored external vCenter credentials are used when available', type : 'string', length : 255, required : False}, {name : 'id', description : 'the VMware CBT migration ID', type : 'uuid', length : 255, required : True, related : 'listVmwareCbtMigrations,cutoverVmwareCbtMigration,cancelVmwareCbtMigration'}, {name : 'username', description : 'optional username override for the source vCenter. Stored external vCenter credentials are used when available', type : 'string', length : 255, required : False}], response : [{name : 'datacentername', description : 'the source VMware datacenter', type : 'string'}, {name : 'accountid', description : 'the account ID', type : 'string'}, {name : 'zoneid', description : 'the destination zone ID', type : 'string'}, {name : 'displayname', description : 'the display name of the target VM', type : 'string'}, {name : 'clustername', description : 'the destination KVM cluster name', type : 'string'}, {name : 'quietcycles', description : 'the number of consecutive quiet CBT delta cycles', type : 'int'}, {name : 'disk', description : 'the source and target disks tracked by this VMware CBT migration', type : 'list'}, {name : 'currentstepduration', description : 'the elapsed time spent in the current migration step', type : 'string'}, {name : 'lastchangedbytes', description : 'the changed bytes observed in the last CBT delta cycle', type : 'long'}, {name : 'state', description : 'the migration state', type : 'string'}, {name : 'cycle', description : 'the CBT delta synchronization cycles tracked by this VMware CBT migration', type : 'list'}, {name : 'currentstep', description : 'the current migration step', type : 'string'}, {name : 'lastdirtyrate', description : 'the dirty rate in bytes per second observed in the last CBT delta cycle', type : 'long'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'convertinstancehostname', description : 'the KVM host name selected for conversion and CBT replication', type : 'string'}, {name : 'totalchangedbytes', description : 'the total changed bytes synchronized across CBT delta cycles', type : 'long'}, {name : 'convertinstancehostid', description : 'the KVM host selected for conversion and CBT replication', type : 'string'}, {name : 'convertinstancepoolid', description : 'the storage pool selected for converted disks', type : 'string'}, {name : 'poolname', description : 'the storage pool name selected for converted disks', type : 'string'}, {name : 'sourcehost', description : 'the source VMware ESXi host', type : 'string'}, {name : 'zonename', description : 'the destination zone name', type : 'string'}, {name : 'id', description : 'the ID of the VMware CBT migration', type : 'string'}, {name : 'vcenter', description : 'the source VMware vCenter', type : 'string'}, {name : 'virtualmachineid', description : 'the ID of the imported VM after cutover', type : 'string'}, {name : 'created', description : 'the create date of the VMware CBT migration', type : 'date'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'string'}, {name : 'completedcycles', description : 'the number of completed CBT delta cycles', type : 'int'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'sourcecluster', description : 'the source VMware cluster', type : 'string'}, {}, {name : 'lasterror', description : 'the last migration error', type : 'string'}, {name : 'lastupdated', description : 'the last updated date of the VMware CBT migration', type : 'date'}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string'}, {name : 'existingvcenterid', description : 'the linked existing vCenter ID, when used', type : 'string'}, {}], httprequesttype : 'POST'}, {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 : 'size', description : 'Size of the disk volume', type : 'long'}, {name : 'diskIopsWriteRate', description : 'IO requests write rate of the disk volume per the disk offering', type : 'long'}, {name : 'maxiops', description : 'Max IOPS of the disk volume', type : 'long'}, {name : 'storageid', description : 'ID of the primary storage hosting the disk volume; returned to admin User only', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'created', description : 'The date the disk volume was created', type : 'date'}, {name : 'chaininfo', description : 'The chain info of the volume', type : 'string'}, {name : 'deleteprotection', description : 'true if volume has delete protection.', 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 : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'clusterid', description : 'Cluster id of the volume', type : 'string'}, {name : 'podid', description : 'Pod id of the volume', type : 'string'}, {}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'type', description : 'Type of the disk volume (ROOT or DATADISK)', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'quiescevm', description : 'Need quiesce Instance or not when taking Snapshot', type : 'boolean'}, {name : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'hypervisor', description : 'Hypervisor the volume belongs to', type : 'string'}, {name : 'isextractable', description : 'True if the volume is extractable, false otherwise', type : 'boolean'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'physicalsize', description : 'The bytes actually consumed on disk', type : 'long'}, {name : 'virtualsize', description : 'The bytes allocated', type : 'long'}, {name : 'podname', description : 'Pod name of the volume', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the disk volume belongs to', type : 'string'}, {name : 'snapshotid', description : 'ID of the Snapshot from which this volume was created', type : 'string'}, {name : 'supportsstoragesnapshot', description : 'True if storage Snapshot is supported for the volume, false otherwise', type : 'boolean'}, {name : 'serviceofferingdisplaytext', description : 'The display text of the service offering for root disk', type : 'string'}, {name : 'kmskeyversion', description : 'Version number of the KMS key used for disk encryption if applicable', type : 'integer'}, {name : 'attached', description : 'The date the volume was attached to an Instance', type : 'date'}, {name : 'status', description : 'The status of the volume', type : 'string'}, {name : 'vmname', description : 'Name of the Instance', type : 'string'}, {name : 'name', description : 'Name of the disk volume', type : 'string'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'diskIopsReadRate', description : 'IO requests read rate of the disk volume per the disk offering', type : 'long'}, {name : 'serviceofferingname', description : 'Name of the service offering for root disk', type : 'string'}, {name : 'projectid', description : 'The project id of the VPN', type : 'string'}, {name : 'encryptformat', description : 'the format of the disk encryption if applicable', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'path', description : 'The path of the volume', type : 'string'}, {name : 'zonename', description : 'Name of the availability zone', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'volumecheckresult', description : 'details for the volume check result, they may vary for different hypervisors', type : 'map'}, {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', type : 'set', response : [{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 : '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 : 'account', description : 'The Account 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 : 'value', description : 'Tag value', type : 'string'}, {name : 'customer', description : 'Customer associated with the tag', type : 'string'}]}, {name : 'clustername', description : 'Cluster name where the volume is allocated', type : 'string'}, {name : 'zoneid', description : 'ID of the availability zone', type : 'string'}, {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 : '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 Instance', type : 'long'}, {name : 'storagetype', description : 'Shared or local storage', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'id', description : 'ID of the disk volume', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'vmtype', description : 'Type of the Instance', type : 'string'}, {name : 'diskofferingid', description : 'ID of the disk offering', type : 'string'}, {name : 'vmdisplayname', description : 'Display name of the Instance', type : 'string'}, {name : 'vmstate', description : 'State of 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 : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'project', description : 'The project name of the VPN', type : 'string'}, {name : 'displayvolume', description : 'An optional field whether to the display the volume to the end User or not.', type : 'boolean'}, {name : 'utilization', description : 'The disk utilization', type : 'string'}, {name : 'provisioningtype', description : 'Provisioning type used to create volumes.', type : 'string'}, {name : 'diskBytesReadRate', description : 'Bytes read rate of the disk volume', type : 'long'}, {name : 'diskofferingdisplaytext', description : 'The display text of the disk offering', type : 'string'}, {name : 'destroyed', description : 'The boolean state of whether the volume is destroyed or not', type : 'boolean'}, {name : 'kmskey', description : 'KMS key name of the volume', type : 'string'}, {name : 'diskBytesWriteRate', description : 'Bytes write rate of the disk volume', type : 'long'}, {name : 'diskofferingname', description : 'Name of the disk offering', type : 'string'}, {name : 'kmskeyid', description : 'KMS key id of the volume', type : 'string'}, {name : 'volumerepairresult', description : 'details for the volume repair result, they may vary for different hypervisors', type : 'map'}, {name : 'miniops', description : 'Min IOPS of the disk volume', type : 'long'}, {name : 'externaluuid', description : 'Volume UUID that is given by virtualisation provider (only for VMware)', type : 'string'}, {name : 'state', description : 'The state of the disk volume', type : 'string'}], httprequesttype : 'POST'}, {name : 'cancelVmwareCbtMigration', description : 'Cancel a VMware CBT migration session', since : '4.24.0', isasync : False, related : 'listVmwareCbtMigrations', params : [{name : 'id', description : 'the VMware CBT migration ID', type : 'uuid', length : 255, required : True, related : 'listVmwareCbtMigrations,cancelVmwareCbtMigration'}], response : [{name : 'displayname', description : 'the display name of the target VM', type : 'string'}, {name : 'poolname', description : 'the storage pool name selected for converted disks', type : 'string'}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string'}, {name : 'lasterror', description : 'the last migration error', type : 'string'}, {name : 'currentstepduration', description : 'the elapsed time spent in the current migration step', type : 'string'}, {name : 'vcenter', description : 'the source VMware vCenter', type : 'string'}, {name : 'convertinstancehostname', description : 'the KVM host name selected for conversion and CBT replication', type : 'string'}, {}, {name : 'created', description : 'the create date of the VMware CBT migration', type : 'date'}, {name : 'accountid', description : 'the account ID', type : 'string'}, {name : 'currentstep', description : 'the current migration step', type : 'string'}, {name : 'sourcecluster', description : 'the source VMware cluster', type : 'string'}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'string'}, {name : 'datacentername', description : 'the source VMware datacenter', type : 'string'}, {name : 'disk', description : 'the source and target disks tracked by this VMware CBT migration', type : 'list'}, {name : 'existingvcenterid', description : 'the linked existing vCenter ID, when used', type : 'string'}, {name : 'zoneid', description : 'the destination zone ID', type : 'string'}, {name : 'quietcycles', description : 'the number of consecutive quiet CBT delta cycles', type : 'int'}, {name : 'totalchangedbytes', description : 'the total changed bytes synchronized across CBT delta cycles', type : 'long'}, {name : 'cycle', description : 'the CBT delta synchronization cycles tracked by this VMware CBT migration', type : 'list'}, {}, {name : 'sourcehost', description : 'the source VMware ESXi host', type : 'string'}, {name : 'completedcycles', description : 'the number of completed CBT delta cycles', type : 'int'}, {name : 'virtualmachineid', description : 'the ID of the imported VM after cutover', type : 'string'}, {name : 'lastupdated', description : 'the last updated date of the VMware CBT migration', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'lastdirtyrate', description : 'the dirty rate in bytes per second observed in the last CBT delta cycle', type : 'long'}, {name : 'convertinstancehostid', description : 'the KVM host selected for conversion and CBT replication', type : 'string'}, {name : 'id', description : 'the ID of the VMware CBT migration', type : 'string'}, {name : 'convertinstancepoolid', description : 'the storage pool selected for converted disks', type : 'string'}, {name : 'clustername', description : 'the destination KVM cluster name', type : 'string'}, {name : 'state', description : 'the migration state', type : 'string'}, {name : 'zonename', description : 'the destination zone name', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'lastchangedbytes', description : 'the changed bytes observed in the last CBT delta cycle', type : 'long'}, {name : 'account', description : 'the account name', 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 : '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 : '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 : '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 : 'backupofferingid', description : 'List by the backup offering', type : 'uuid', length : 255, required : False, since : '4.17', related : ''}, {name : 'domainid', description : 'List only resources belonging to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {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 : 'securitygroupid', description : 'The security group ID', type : 'uuid', length : 255, required : False, since : '4.15', related : ''}, {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 : 'vpcid', description : 'List Instances by VPC', type : 'uuid', length : 255, required : False, related : 'createVPC,listVPCs,updateVPC'}, {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 : 'keypair', description : 'List Instances by SSH keypair name', type : 'string', length : 255, required : False}, {name : 'networkid', description : 'List by Network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,updateNetwork,listNetworks'}, {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 : '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 : 'page', 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 : ''}, {name : 'userdataid', description : 'the instances by userdata', type : 'uuid', length : 255, required : False, since : '4.20.1', related : ''}, {name : 'leased', description : 'Whether to return only leased instances', type : 'boolean', length : 255, required : False, since : '4.21.0'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string', length : 255, required : False, since : '4.20.1'}, {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 : 'autoscalevmgroupid', description : 'The ID of AutoScaling Instance Group', type : 'uuid', length : 255, required : False, since : '4.18.0', related : ''}, {name : 'hypervisor', description : 'The target hypervisor for the Template', type : 'string', length : 255, required : False}, {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 : '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 : '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 : 'extensionid', description : 'The ID of the Orchestrator extension for the VM', type : 'uuid', length : 255, required : False, since : '4.21.0', related : 'listExtensions'}, {name : 'serviceofferingid', description : 'List by the service offering', type : 'uuid', length : 255, required : False, since : '4.4', related : 'updateServiceOffering,listServiceOfferings'}, {name : 'affinitygroupid', description : 'List Instances by affinity group', type : 'uuid', length : 255, required : False, related : ''}, {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 : '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 : 'showicon', description : 'Flag to display the resource icon for Instances', type : 'boolean', length : 255, required : False, since : '4.16.0.0'}, {name : 'account', description : 'List resources by Account. Must be used with the domainId parameter.', type : 'string', 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 : 'isoid', description : 'List Instances by ISO', type : 'uuid', 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 : 'zoneid', description : 'The availability zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'groupid', description : 'The group ID', type : 'uuid', length : 255, required : False, related : ''}], response : [{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 : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {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 : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'account', description : 'The Account associated with the Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {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 : 'tags', description : 'The list of resource tags associated with the rule', type : 'set', response : [{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 : 'projectid', description : 'The project ID the tag belongs to', 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 : 'domainpath', description : 'Path of the Domain 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 : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'domain', description : 'The domain associated with the tag', type : 'string'}]}, {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 : '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 : '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 : 'account', description : 'Account owning 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 : '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 : 'project', description : 'The project name of the 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 : 'domainid', description : 'The domain ID of the security group', type : 'string'}, {name : 'name', description : 'The name of the security 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 : '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 : '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 : 'ruleid', description : 'The ID 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 : '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 : 'value', description : 'Tag value', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', 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 : '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 : '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 : 'description', description : 'The description of the security group', 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 : '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 : '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 : 'projectid', description : 'The project ID the 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 : '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 : 'id', description : 'The ID of the security group', type : 'string'}, {name : 'virtualmachineids', description : 'The list of Instance IDs associated with this Security Group', type : 'set'}]}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'broadcasturi', description : 'The broadcast URI of the NIC', type : 'string'}, {name : 'type', description : 'The type of the NIC', 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 : 'ip6cidr', description : 'The CIDR of IPv6 Network', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}, {name : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', 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 : 'publicipid', description : 'Public IP address ID associated with this NIC via Static NAT rule', type : 'string'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'isolatedpvlan', description : 'The isolated private VLAN if available', type : 'integer'}, {name : 'isolationuri', description : 'The isolation URI of the NIC', 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 : 'networkname', description : 'The name of the corresponding Network', type : 'string'}, {name : 'netmask', description : 'The netmask of the NIC', type : 'string'}, {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 : '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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'isolatedpvlantype', description : 'The isolated private VLAN type if available', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', 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 : 'vlanid', description : 'ID of the VLAN/VNI if available', type : 'integer'}, {name : 'traffictype', description : 'The traffic type of the NIC', 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 : 'macaddress', description : 'True if NIC is default, false otherwise', type : 'string'}, {name : 'ipaddresses', description : 'IP addresses associated with NIC found for unmanaged Instance', type : 'list'}]}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'rootdevicetype', description : 'Device type of the root volume', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', 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 : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'templatename', description : 'The name of the Template for 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 : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'userdata', description : 'Base64 string containing the user data', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'cpunumber', description : 'The number of vCPUs this Instance is using', type : 'integer'}, {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 : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'name', description : 'The name 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 : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", 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 : 'ipaddress', description : "the VM's primary IP address", type : 'string'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", 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 : '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 : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {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', 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 : 'value', description : 'Tag value', 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 : 'customer', description : 'Customer 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 : 'resourceid', description : 'ID of the resource', type : 'string'}, {name : 'resourcetype', description : 'Resource type', type : 'string'}]}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'displayvm', description : 'An optional field whether to the display the Instance to the end user or not.', type : 'boolean'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'diskkbsread', description : "The Instance's disk read 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 : '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 : '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 : 'created', description : 'The date when this Instance was created', type : 'date'}, {name : 'projectid', description : 'The project ID of the Instance', type : 'string'}, {name : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'vgpuprofileid', description : 'the ID of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'zoneid', description : 'The ID of the availability zone for the Instance', type : 'string'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'maxheads', description : 'the maximum number of display heads', type : 'long'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {}, {name : 'userdataname', description : 'The name of userdata used for 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 : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'state', description : 'The state of 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 : '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 : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', 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 : '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 : 'hypervisor', description : 'The hypervisor on which the Template runs', 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 : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'name', description : 'The 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 : 'project', description : 'The project name of the affinity group', type : 'string'}, {name : 'type', description : 'The type of the affinity group', type : 'string'}, {name : 'domainpath', description : 'path of the Domain the affinity group belongs to', 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 : 'dedicatedresources', description : 'dedicated resources 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 Instance', type : 'string'}], httprequesttype : 'GET'}, {name : 'updateInstanceBootGroupReadinessRule', description : 'Updates an Instance Boot Group readiness rule. The rule type, Instance Boot Group and item are immutable after creation.', since : '24.0', isasync : False, related : '', params : [{name : 'enabled', description : 'Whether the rule is enabled', type : 'boolean', length : 255, required : False}, {name : 'name', description : 'New name for the readiness rule', type : 'string', length : 255, required : False}, {name : 'id', description : 'The ID of the readiness rule', type : 'uuid', length : 255, required : True, related : 'updateInstanceBootGroupReadinessRule'}, {name : 'details', description : 'Rule-type-specific configuration', type : 'map', length : 255, required : False}], response : [{name : 'enabled', description : 'Whether the rule is enabled', type : 'boolean'}, {name : 'checkedon', description : 'When this rule was last evaluated', type : 'date'}, {name : 'id', description : 'The ID of the readiness rule', type : 'string'}, {}, {name : 'memberid', description : 'The ID of the item (VM or instance group) this rule applies to', type : 'string'}, {name : 'readinessstatus', description : 'The last cached evaluation status of this rule: READY, NOT_READY, ERROR or UNKNOWN', type : 'string'}, {}, {name : 'created', description : 'The date the rule was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'name', description : 'The name of the readiness rule', type : 'string'}, {name : 'statusmessage', description : 'The message from the last evaluation of this rule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'ruletype', description : 'The readiness rule type', type : 'string'}, {name : 'details', description : 'Rule-type-specific configuration', type : 'map'}, {name : 'membertype', description : 'The item type this rule applies to: VirtualMachine or InstanceGroup', type : 'string'}, {name : 'membername', description : 'The name of the item (VM or instance group) this rule applies to', type : 'string'}, {name : 'bootgroupid', description : 'The ID of the boot group this rule belongs to', type : 'string'}, {name : 'inherited', description : "True if this rule is not attached to the queried item directly, but inherited from its owning InstanceGroup (only possible when listing by virtualmachineid; the rule's itemtype/itemid still refer to the InstanceGroup it's actually attached to)", type : 'boolean'}], httprequesttype : 'POST'}, {name : 'listSystemVmsUsageHistory', description : 'Lists System VM stats', since : '4.18.0', isasync : False, related : '', params : [{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 : 'pagesize', description : '', type : 'integer', 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 : 'page', description : '', type : 'integer', 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 : 'enddate', description : 'End date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")', type : 'date', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', 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}], response : [{name : 'stats', description : 'The list of Instance stats', type : 'list', response : [{name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'memoryintfreekbs', description : "The Instance's free memory in KB or -1 if it cannot be gathered", type : 'long'}, {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 : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'networkread', description : 'The amount of downloaded data by the Instance in MiB', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KB)', type : 'long'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {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 : 'cpuused', description : "The amount (percentage) of the Instance's CPU currently used", type : 'string'}, {name : 'networkwrite', description : 'The amount of uploaded data by the Instance in MiB', type : 'string'}, {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 : '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 : '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 : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'name', description : 'The Name of the Instance', type : 'string'}, {}, {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 : '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 : 'listVMSnapshot', description : 'List Instance Snapshot by conditions', since : '4.2.0', isasync : False, related : 'createVMSnapshot', params : [{name : 'tags', description : 'List resources by tags (key/value pairs)', type : 'map', length : 255, required : False}, {name : 'name', description : 'Lists Snapshot by Snapshot name or display name', type : 'string', length : 255, required : False}, {name : 'state', description : 'State of the Instance Snapshot', type : 'string', 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 : 'vmsnapshotid', description : 'The ID of the Instance Snapshot', type : 'uuid', length : 255, required : False, 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 : '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 : '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 : '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 : '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 : 'page', description : '', type : 'integer', length : 255, required : False}], response : [{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 : 'current', description : 'Indicates if this is current Snapshot', type : 'boolean'}, {name : 'parent', description : 'The parent ID of the Instance Snapshot', type : 'string'}, {name : 'projectid', description : 'The project ID of the VPN', type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID of the Instance Snapshot', type : 'string'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {}, {name : 'description', description : 'The description of the Instance Snapshot', 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 Snapshot', type : 'string'}, {}, {name : 'parentName', description : 'The parent displayName of the Instance Snapshot', type : 'string'}, {name : 'hypervisor', description : 'The type of hypervisor on which Snapshot is stored', type : 'string'}, {name : 'state', description : 'The state of the Instance Snapshot', type : 'state'}, {name : 'zonename', description : 'The Zone name of the Instance Snapshot', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'displayname', description : 'The display name of the Instance Snapshot', type : 'string'}, {name : 'virtualmachinename', description : 'The Instance name of the Instance Snapshot', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'zoneid', description : 'The Zone ID 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 : '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 : 'domainpath', description : 'Path of 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 : '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 : 'type', description : 'Instance Snapshot type', type : 'string'}, {name : 'created', description : 'The create date of the Instance Snapshot', type : 'date'}, {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 : 'id', description : 'The UUID of the KMS key to update', type : 'uuid', length : 255, required : True, related : 'updateKMSKey'}, {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}], response : [{}, {name : 'id', description : 'the UUID of the key', type : 'string'}, {name : 'zoneid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'enabled', description : 'whether the key is enabled', type : 'boolean'}, {name : 'description', description : 'the description of the key', type : 'string'}, {name : 'projectid', description : 'the project ID of the key', type : 'string'}, {name : 'name', description : 'the name of the key', type : 'string'}, {name : 'account', description : 'the account owning the key', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'keklabel', description : 'the provider-specific KEK label (admin only)', type : 'string'}, {name : 'hsmprofileid', description : 'the zone ID where the key is valid', type : 'string'}, {name : 'hsmprofile', description : 'the zone name where the key is valid', type : 'string'}, {}, {name : 'domain', description : 'the domain name of the key', type : 'string'}, {name : 'algorithm', description : 'the encryption algorithm', type : 'string'}, {name : 'domainid', description : 'the domain ID of the key', type : 'string'}, {name : 'keybits', description : 'the key size in bits', type : 'integer'}, {name : 'project', description : 'the project name of the key', type : 'string'}, {name : 'accountid', description : 'the account ID owning the key', type : 'string'}, {name : 'created', description : 'the creation timestamp', type : 'date'}, {name : 'zonename', description : 'the zone name where the key is valid', type : 'string'}, {name : 'version', description : 'the key size in bits', type : 'integer'}, {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'}], 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 : 'related', description : 'Comma separated related apis', 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'}, {name : 'name', description : 'The name of the API command', type : 'string'}, {name : 'params', description : 'The list params the api accepts', type : 'set', response : [{name : 'related', description : 'Comma separated related APIs to get the parameter', type : 'string'}, {name : 'type', description : 'Parameter type', type : 'string'}, {name : 'since', description : 'Version of CloudStack the API was introduced in', type : 'string'}, {name : 'description', description : 'Description of the API parameter', type : 'string'}, {}, {name : 'required', description : 'True if this parameter is required for the API request', type : 'boolean'}, {name : 'length', description : 'Length of the parameter', type : 'int'}, {name : 'name', description : 'The name of the API parameter', type : 'string'}]}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'description', description : 'Description of the API', type : 'string'}, {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 : 'response', description : 'API response fields', type : 'set', response : [{name : 'description', description : 'Description of the API response field', type : 'string'}, {name : 'name', description : 'The name of the API response field', type : 'string'}, {name : 'response', description : 'API response fields', type : 'set'}, {name : 'type', description : 'Response field type', type : 'string'}]}], httprequesttype : 'GET'}, {name : 'createVMSnapshot', description : 'Creates Snapshot for an Instance. Running KVM UEFI disk-only snapshots briefly suspend the Instance while copying NVRAM state.', since : '4.2.0', isasync : True, related : '', params : [{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 : 'quiescevm', description : 'Quiesce Instance if true', type : 'boolean', length : 255, required : False}, {name : 'snapshotmemory', description : 'Snapshot memory if true', type : 'boolean', length : 255, required : False}, {name : 'description', description : 'The description of the Snapshot', type : 'string', length : 255, required : False}, {name : 'name', description : 'The display name of the Snapshot', type : 'string', length : 255, required : False}], response : [{name : 'description', description : 'The description of the Instance Snapshot', type : 'string'}, {name : 'created', description : 'The create date of the Instance Snapshot', type : 'date'}, {}, {name : 'state', description : 'The state of the Instance Snapshot', type : 'state'}, {name : 'virtualmachinename', description : 'The Instance name of the Instance Snapshot', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'current', description : 'Indicates if this is current Snapshot', type : 'boolean'}, {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 VPN', type : 'string'}, {name : 'parentName', description : 'The parent displayName of the Instance Snapshot', type : 'string'}, {name : 'hypervisor', description : 'The type of hypervisor on which Snapshot is stored', type : 'string'}, {name : 'id', description : 'The ID of the Instance Snapshot', type : 'string'}, {name : 'type', description : 'Instance Snapshot type', type : 'string'}, {name : 'virtualmachineid', description : 'The Instance ID of the Instance Snapshot', type : 'string'}, {name : 'parent', description : 'The parent ID of the Instance Snapshot', type : 'string'}, {name : 'domainpath', description : 'Path of the domain to which the disk volume belongs', type : 'string'}, {name : 'zoneid', description : 'The Zone ID of the Instance Snapshot', type : 'string'}, {name : 'account', description : 'The Account associated with the disk volume', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the disk volume', type : 'string'}, {name : 'displayname', description : 'The display name of the Instance Snapshot', type : 'string'}, {name : 'projectid', description : 'The project ID of the VPN', 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 : '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 : 'projectid', description : 'The project ID the tag belongs to', 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 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 : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'account', description : 'The Account associated with the tag', type : 'string'}]}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'domain', description : 'The domain associated with the disk volume', type : 'string'}, {name : 'zonename', description : 'The Zone name of the Instance Snapshot', type : 'string'}], httprequesttype : 'POST'}, {name : 'listVmwareCbtMigrations', description : 'List VMware CBT based migration sessions', since : '4.24.0', isasync : False, related : '', params : [{name : 'zoneid', description : 'the destination zone ID', type : 'uuid', length : 255, required : False, related : 'listZones'}, {name : 'accountid', description : 'the account ID', type : 'uuid', length : 255, required : False, related : 'enableAccount,listAccounts'}, {name : 'id', description : 'the VMware CBT migration ID', type : 'uuid', length : 255, required : False, related : 'listVmwareCbtMigrations'}, {name : 'state', description : 'the migration state', type : 'string', length : 255, required : False}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string', length : 255, required : False}, {name : 'vcenter', description : 'the source VMware vCenter', 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 : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'convertinstancepoolid', description : 'the storage pool selected for converted disks', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'zonename', description : 'the destination zone name', type : 'string'}, {name : 'poolname', description : 'the storage pool name selected for converted disks', type : 'string'}, {name : 'id', description : 'the ID of the VMware CBT migration', type : 'string'}, {name : 'zoneid', description : 'the destination zone ID', type : 'string'}, {name : 'virtualmachineid', description : 'the ID of the imported VM after cutover', type : 'string'}, {name : 'existingvcenterid', description : 'the linked existing vCenter ID, when used', type : 'string'}, {name : 'disk', description : 'the source and target disks tracked by this VMware CBT migration', type : 'list'}, {name : 'clustername', description : 'the destination KVM cluster name', type : 'string'}, {name : 'convertinstancehostname', description : 'the KVM host name selected for conversion and CBT replication', type : 'string'}, {name : 'vcenter', description : 'the source VMware vCenter', type : 'string'}, {name : 'sourcecluster', description : 'the source VMware cluster', type : 'string'}, {name : 'sourcevmname', description : 'the source VMware VM name', type : 'string'}, {}, {name : 'created', description : 'the create date of the VMware CBT migration', type : 'date'}, {name : 'lastdirtyrate', description : 'the dirty rate in bytes per second observed in the last CBT delta cycle', type : 'long'}, {name : 'accountid', description : 'the account ID', type : 'string'}, {name : 'cycle', description : 'the CBT delta synchronization cycles tracked by this VMware CBT migration', type : 'list'}, {name : 'clusterid', description : 'the destination KVM cluster ID', type : 'string'}, {name : 'totalchangedbytes', description : 'the total changed bytes synchronized across CBT delta cycles', type : 'long'}, {name : 'state', description : 'the migration state', type : 'string'}, {name : 'currentstep', description : 'the current migration step', type : 'string'}, {name : 'displayname', description : 'the display name of the target VM', type : 'string'}, {name : 'lasterror', description : 'the last migration error', type : 'string'}, {}, {name : 'lastchangedbytes', description : 'the changed bytes observed in the last CBT delta cycle', type : 'long'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'convertinstancehostid', description : 'the KVM host selected for conversion and CBT replication', type : 'string'}, {name : 'datacentername', description : 'the source VMware datacenter', type : 'string'}, {name : 'account', description : 'the account name', type : 'string'}, {name : 'lastupdated', description : 'the last updated date of the VMware CBT migration', type : 'date'}, {name : 'quietcycles', description : 'the number of consecutive quiet CBT delta cycles', type : 'int'}, {name : 'completedcycles', description : 'the number of completed CBT delta cycles', type : 'int'}, {name : 'sourcehost', description : 'the source VMware ESXi host', type : 'string'}, {name : 'currentstepduration', description : 'the elapsed time spent in the current migration step', type : 'string'}], httprequesttype : 'GET'}, {name : 'getUploadParamsForIso', description : 'Upload an existing ISO into the CloudStack cloud.', since : '4.13', isasync : False, related : '', params : [{name : 'displaytext', description : 'The display text of the ISO. This is usually used for display purposes.', type : 'string', length : 4096, 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 : 'isextractable', description : 'True if the ISO or its derivatives are extractable; default is false', 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 : 'account', description : 'An optional accountName. Must be used with domainId.', 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 : 'projectid', description : 'Upload Volume/Template/ISO for the project', type : 'uuid', length : 255, required : False, related : ''}, {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}, {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 : '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 : '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 : 'name', description : 'The name of the Volume/Template/ISO', type : 'string', length : 255, required : True}, {name : 'isfeatured', description : 'True if you want this ISO to be featured', type : 'boolean', length : 255, required : False}], response : [{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 : '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 : 'postURL', description : 'POST url to upload the file to', type : 'url'}, {}, {name : 'metadata', description : 'Encrypted data to be sent in the POST request.', type : 'string'}, {name : 'id', description : 'The Template/volume ID', type : 'uuid'}], 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 : '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 : 'listUserKeys', description : 'Lists the API key pairs (API and secret keys) of a user.', since : '4.23.0', isasync : False, related : '', params : [{name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}, {name : 'apikeyfilter', description : 'API key of the key pair.', type : 'string', length : 255, required : False}, {name : 'showpermissions', description : 'Whether API Key rules should be returned. Defaults to false.', type : 'boolean', length : 255, required : False}, {name : 'pagesize', description : '', type : 'integer', length : 255, required : False}, {name : 'userid', description : 'ID of the user that owns the keys.', type : 'uuid', length : 255, required : False, related : 'getUser'}, {name : 'page', description : '', type : 'integer', 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 : 'keypairid', description : 'ID of the key pair.', type : 'uuid', length : 255, required : False, related : 'listUserKeys'}], response : [{name : 'id', description : 'ID of the API key pair.', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'startdate', description : 'API key pair start date.', type : 'date'}, {name : 'domainpath', description : 'Path of the domain which the account belongs to.', type : 'string'}, {name : 'roleid', description : 'ID of the role.', type : 'string'}, {name : 'permissions', description : 'Permissions of the API key pair.', type : 'list'}, {name : 'username', description : "Username of the keypair's owner.", type : 'string'}, {}, {name : 'domain', description : 'Name of the domain which the account belongs to.', type : 'string'}, {}, {name : 'name', description : 'Name of the API key pair', type : 'string'}, {name : 'enddate', description : 'API key pair expiration date.', type : 'date'}, {name : 'userid', description : 'ID of the user that owns the keypair.', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'created', description : 'API key pair creation timestamp.', type : 'date'}, {name : 'state', description : 'State of the API key pair.', type : 'apikeypairstate'}, {name : 'accounttype', description : 'Account type.', type : 'string'}, {name : 'rolename', description : 'Name of the role.', type : 'string'}, {name : 'domainid', description : 'ID of the domain which the account belongs to.', type : 'string'}, {name : 'accountid', description : 'Account ID.', type : 'string'}, {name : 'secretkey', description : 'The secret key of the registered user.', type : 'string'}, {name : 'description', description : 'API key pair description.', type : 'string'}, {name : 'accountname', description : 'Account name.', type : 'string'}, {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 : 'roletype', description : 'Type of the role (Admin, ResourceAdmin, DomainAdmin, User).', type : 'string'}], 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 : '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 : 'domainpath', description : 'Path of the domain to which the Kubernetes cluster belongs', 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 : 'id', description : 'The ID of the Kubernetes cluster', type : 'string'}, {name : 'ipaddressid', description : 'Public IP Address ID of the cluster', type : 'string'}, {name : 'consoleendpoint', description : 'URL end point for the Kubernetes cluster dashboard UI', 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 : '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 : 'controlnodes', description : 'The control nodes count for the Kubernetes cluster', type : 'long'}, {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 : '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 : 'templatename', description : 'the name of the template of the Kubernetes cluster', type : 'string'}, {name : 'keypair', description : 'Keypair details', type : 'string'}, {name : 'controlofferingname', description : 'the name of the service offering of the control nodes on the Kubernetes cluster', type : 'string'}, {name : 'cniconfigname', description : 'Name of CNI Configuration associated with the cluster', type : 'string'}, {name : 'endpoint', description : 'URL end point for the Kubernetes cluster', type : 'string'}, {name : 'etcdnodes', description : 'the number of the etcd nodes on the Kubernetes cluster', type : 'long'}, {name : 'etcdaffinitygroupnames', description : 'The names of affinity groups associated with etcd nodes', type : 'string'}, {name : 'zoneid', description : 'The name of the zone 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 : 'csienabled', description : 'Indicates if the CloudStack CSI driver has been setup in the cluster', type : 'boolean'}, {name : 'kubernetesversionid', description : 'The ID 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 : '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 : 'serviceofferingid', description : 'The ID of the service offering of the Kubernetes cluster', 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 : 'etcdofferingname', description : 'the name of the service offering of the etcd nodes on 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 : 'memory', description : 'The memory 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 : 'masternodes', description : "The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", type : 'long'}, {name : 'etcdips', description : 'Public IP Addresses of the etcd nodes', type : 'map'}, {name : 'state', description : 'The state of the Kubernetes cluster', type : 'string'}, {name : 'description', description : 'The description of the Kubernetes cluster', type : 'string'}, {name : 'created', description : 'The date when this Kubernetes cluster was created', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'kubernetesversionname', description : 'The name of the Kubernetes version for the Kubernetes cluster', type : 'string'}, {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 : 'controlaffinitygroupnames', description : 'The names of affinity groups associated with control nodes', type : 'string'}, {name : 'associatednetworkname', description : 'The name of the network of the Kubernetes cluster', type : 'string'}, {name : 'serviceofferingname', description : 'The name of the service offering of the Kubernetes cluster', type : 'string'}, {name : 'account', description : 'The Account associated with 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 : 'controlaffinitygroupids', description : 'The IDs of affinity groups associated with control nodes', type : 'string'}], httprequesttype : 'POST'}, {name : 'listSharedFileSystemProviders', description : 'Lists all available shared filesystem providers.', since : '4.20.0', isasync : False, related : '', params : [{name : 'pagesize', description : '', type : 'integer', 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}], response : [{}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {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'}, {}], httprequesttype : 'GET'}, {name : 'listBackupSchedule', description : 'List backup schedule of an Instance', since : '4.14.0', isasync : False, related : '', params : [{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 : 'id', description : 'the ID of the backup schedule', type : 'uuid', length : 255, required : False, since : '4.22.0', related : 'listBackupSchedule'}, {name : 'pagesize', 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 : 'listDomains'}, {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 : '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 : 'page', description : '', type : 'integer', length : 255, required : False}, {name : 'keyword', description : 'List by keyword', type : 'string', length : 255, required : False}], response : [{name : 'virtualmachinename', description : 'Name of the Instance', type : 'string'}, {name : 'maxbackups', description : 'maximum number of backups retained', type : 'integer'}, {name : 'id', description : 'ID of the backup schedule.', type : 'string'}, {}, {name : 'schedule', description : 'The time the backup is scheduled to be taken.', type : 'string'}, {}, {name : 'quiescevm', description : 'quiesce the instance before checkpointing the disks for backup', type : 'boolean'}, {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 : 'intervaltype', description : 'The interval type of the backup schedule', type : 'intervaltype'}, {name : 'virtualmachineid', description : 'ID of the Instance', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'timezone', description : 'The time zone of the backup schedule', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}], httprequesttype : 'GET'}, {name : 'restoreVolumeFromBackupAndAttachToVM', description : 'Restore and attach a backed up volume to Instance', since : '4.14.0', isasync : True, params : [{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'}, {name : 'volumeid', description : 'ID of the volume backed up', type : 'string', length : 255, required : True}, {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 : ''}], 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 : 'removeNetworkPermissions', description : 'Removes Network permissions.', since : '4.17.0', isasync : False, params : [{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 : 'networkid', description : 'The Network ID', type : 'uuid', length : 255, required : True, related : 'createNetwork,updateNetwork,listNetworks'}, {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 : '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 : '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 : '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 : 'deleteProjectRolePermission', description : 'Deletes a project role permission in the project', since : '4.15.0', isasync : False, params : [{name : 'id', description : 'ID of the project role permission to be deleted', type : 'uuid', length : 255, required : True, related : ''}, {name : 'projectid', description : 'ID of the project where the project role permission is to be deleted', type : 'uuid', length : 255, required : True, related : ''}], 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 : '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 : 'passwordenabled', description : 'True if the image supports the password reset feature; default is false', type : 'boolean', 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 : 'cleanupvnfnics', description : 'optional boolean field, which indicates if VNF nics will be cleaned up or not', type : 'boolean', length : 255, required : False}, {name : 'format', description : 'The format for the image', type : 'string', length : 255, required : False}, {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 : 'cleanupvnfdetails', description : 'optional boolean field, which indicates if VNF details will be cleaned up or not', type : 'boolean', length : 255, required : False}, {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 : '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 : 'sortkey', description : 'Sort key of the Template, integer', type : 'integer', length : 255, required : False}, {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 : '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 : 'ostypeid', description : 'The ID of the OS type that best represents the OS of this image.', type : 'uuid', length : 255, required : False, related : ''}, {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 : 'templatetag', description : 'the tag for this template.', type : 'string', length : 255, required : False, since : '4.20.0'}, {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 : '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 : '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 : 'displaytext', description : 'The display text of the image', type : 'string', length : 4096, 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 : '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 : 'bootable', description : 'True if image is bootable, false otherwise; available only for updateIso API', 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'}], response : [{name : 'templatetype', description : 'The type of the Template', type : 'string'}, {name : 'isextractable', description : 'True if the Template is extractable, false otherwise', type : 'boolean'}, {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 : 'extensionid', description : 'The ID of extension linked to this template', type : 'string'}, {name : 'domainpath', description : 'Path of the Domain the template belongs to', type : 'string'}, {name : 'extensionname', description : 'The name of extension linked to this template', type : 'string'}, {name : 'hostname', description : 'The name 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 : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {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 : 'isdynamicallyscalable', description : 'True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory', type : 'boolean'}, {name : 'forcks', description : 'If true it indicates that the template can be used for CKS cluster deployments', type : 'boolean'}, {name : 'physicalsize', description : 'The physical size of the Template', type : 'long'}, {name : 'sourcetemplateid', description : 'The Template ID of the parent Template if present', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'templatetag', description : 'The tag of this Template', type : 'string'}, {name : 'sshkeyenabled', description : 'True if Template is sshkey enabled, false otherwise', type : 'boolean'}, {name : 'name', description : 'The Template name', type : 'string'}, {name : 'account', description : 'The Account name to which the Template belongs', type : 'string'}, {name : 'userdataname', description : 'The name of userdata linked to this Template', type : 'string'}, {name : 'bootable', description : 'True if the ISO is bootable, false otherwise', type : 'boolean'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'url', description : 'The URL which the Template/ISO is registered from', type : 'string'}, {name : 'ostypename', description : 'The name of the OS type for this Template.', type : 'string'}, {name : 'domain', description : 'The name of the domain to which the Template belongs', type : 'string'}, {name : 'userdataid', description : 'The id of userdata linked to this Template', type : 'string'}, {name : 'hostid', description : 'The ID of the secondary storage host for the Template', type : 'string'}, {}, {name : 'zoneid', description : 'The ID of the zone for this Template', type : 'string'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {name : 'id', description : 'The Template ID', type : 'string'}, {name : 'format', description : 'The format of the Template.', type : 'imageformat'}, {name : 'displaytext', description : 'The Template display text', type : 'string'}, {name : 'projectid', description : 'The project ID of the Template', type : 'string'}, {name : 'created', description : 'The date this Template was created', type : 'date'}, {name : 'details', description : 'Additional key/value details tied with Template', type : 'map'}, {name : 'childtemplates', description : 'If root disk Template, then IDs of the datas disk Templates this Template owns', type : 'set'}, {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 : 'bits', description : 'The processor bit size', type : 'int'}, {name : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'status', description : 'The status of the Template', 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 : '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 : '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 : '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 : 'size', description : 'The size of the Template', type : 'long'}, {name : 'downloaddetails', description : 'Lists the download progress of a Template across all secondary storages', type : 'list'}, {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 : 'zonename', description : 'The name of the zone for this Template', type : 'string'}, {name : 'isready', description : 'True if the Template is ready to be deployed from, false otherwise.', type : 'boolean'}, {name : 'ostypeid', description : 'The ID of the OS type 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 : 'ispublic', description : 'True if this Template is a public Template, false otherwise', type : 'boolean'}, {name : 'removed', description : 'The date this Template was removed', type : 'date'}, {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 : 'deployasisdetails', description : 'VMware only: additional key/value details tied with deploy-as-is Template', type : 'map'}, {name : 'project', description : 'The project name of the Template', type : 'string'}, {name : 'arch', description : 'CPU Arch of the 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 : 'name', description : 'The user two factor authenticator provider name', type : 'string'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'description', description : 'The description of the user two factor authenticator provider', type : 'string'}, {}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {}], 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 : 'name', description : 'The name of the Instance as it is known to the hypervisor', type : 'string', length : 255, required : True}, {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 : 'displayname', description : 'The display name of the Instance', type : 'string', length : 255, required : False}, {name : 'networkid', description : 'the network ID', type : 'uuid', length : 255, required : False, related : 'createNetwork,updateNetwork,listNetworks'}, {name : 'hostname', description : 'The host name of the Instance', type : 'string', length : 255, required : False}, {name : 'domainid', description : 'Import Instance to the domain specified', type : 'uuid', length : 255, required : False, related : 'listDomains'}, {name : 'nicipaddresslist', description : 'VM NIC to ip address mapping using keys NIC, ip4Address', type : 'map', length : 255, required : False}, {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 : 'clusterid', description : 'The cluster ID', type : 'uuid', length : 255, required : True, related : ''}, {name : 'importsource', description : 'Source location for Import', type : 'string', length : 255, required : True}, {name : 'datacentername', description : '(only for importing VMs from VMware to KVM) Name of VMware datacenter.', type : 'string', length : 255, required : False}, {name : 'details', description : 'Used to specify the custom parameters.', type : 'map', 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 : '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 : '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 : 'vmwaremigrationmode', description : '(only for importing VMs from VMware to KVM) optional - migration mode to use. Valid values are OVF, VDDK, and CBT. When omitted, CloudStack preserves the existing usevddk behavior.', type : 'string', length : 255, required : False, since : '4.22.1'}, {name : 'serviceofferingid', description : 'The service offering for the Instance', type : 'uuid', length : 255, required : True, related : 'updateServiceOffering'}, {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 : 'temppath', description : 'Temp Path on external host for disk image copy', type : 'string', length : 255, required : False}, {name : 'templateid', description : 'The ID of the Template for the Instance. Required when the instance to import is an unmanaged KVM Instance.', type : 'uuid', length : 255, required : False, related : 'listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate'}, {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 : 'nicnetworklist', description : 'VM NIC to network id mapping using keys NIC and network', type : 'map', length : 255, required : False}, {name : 'hostip', description : '(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.', type : 'string', length : 255, required : False}, {name : 'username', description : 'the username for the host', type : 'string', 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 : '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 : 'hostid', description : 'Host where local disk is located', 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 : 'projectid', description : 'Import Instance for the project', type : 'uuid', length : 255, required : False, related : ''}, {name : 'host', description : 'the host name or IP address', type : 'string', length : 255, required : False}, {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. When usevddk and forceconverttopool are true, this can be an RBD primary storage pool for direct RBD import.', type : 'uuid', length : 255, required : False, related : ''}, {name : 'password', description : 'the password for the host', type : 'string', length : 255, required : False}, {name : 'storageid', description : 'Shared storage pool where disk is located', type : 'uuid', length : 255, required : False, related : ''}, {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 : 'hypervisor', description : 'hypervisor type of the host', 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. With forceconverttopool=true and an RBD conversion pool, the source VMware VM must be powered off and the conversion host must support qemu RBD access and in-place virt-v2v finalization.', type : 'boolean', length : 255, required : False, since : '4.22.1'}, {name : 'clustername', description : '(only for importing VMs from VMware to KVM) Name of VMware cluster.', type : 'string', length : 255, required : False}, {name : 'zoneid', description : 'the zone ID', type : 'uuid', length : 255, required : True, related : 'listZones'}, {name : 'datadiskofferinglist', description : 'Datadisk Template to disk-offering mapping using keys disk and diskOffering', 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}], response : [{name : 'hostname', description : 'The name of the host for the Instance', type : 'string'}, {name : 'maxresolutionx', description : 'the maximum X resolution', type : 'long'}, {name : 'hypervisor', description : 'The hypervisor on which the Template runs', type : 'string'}, {name : 'backupofferingname', description : 'The name of the backup offering of the Instance', type : 'string'}, {name : 'templatename', description : 'The name of the Template for the Instance', type : 'string'}, {name : 'servicestate', description : 'State of the Service from LB rule', type : 'string'}, {name : 'state', description : 'The state of the Instance', type : 'string'}, {name : 'diskkbswrite', description : "The Instance's disk write in KiB", type : 'long'}, {name : 'userdataname', description : 'The name of userdata used for 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 : 'vmtype', description : 'User VM type', type : 'string'}, {name : 'keypairs', description : 'SSH key-pairs', type : 'string'}, {name : 'cpuused', description : "The amount of the Instance's CPU currently used", type : 'string'}, {name : 'vgpu', description : 'The vGPU type used by the Instance', type : 'string'}, {name : 'groupid', description : 'The group ID of the Instance', type : 'string'}, {name : 'password', description : 'The password (if exists) of the Instance', type : 'string'}, {name : 'networkkbswrite', description : 'The outgoing Network traffic on the host in KiB', type : 'long'}, {name : 'hostid', description : 'The ID of the host for the Instance', type : 'string'}, {name : 'ostypeid', description : 'OS type id of the Instance', type : 'string'}, {name : 'leaseduration', description : 'Instance lease duration in days', type : 'integer'}, {name : 'rootdevicetype', description : 'Device type of the root 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 : '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 : '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 : 'name', description : 'The name of the attached ISO', type : 'string'}]}, {}, {name : 'gpucardid', description : 'the ID of the gpu card to which service offering is linked', type : 'string'}, {name : 'leaseexpirydate', description : 'Instance lease expiry date', type : 'date'}, {name : 'jobid', description : 'The UUID of the latest async job acting on this object', type : 'string'}, {name : 'memorytargetkbs', description : 'The target memory in Instance (KiB)', type : 'long'}, {name : 'hostcontrolstate', description : 'The control state of the host for the Instance', type : 'string'}, {name : 'vnfdetails', description : 'VNF details', type : 'map'}, {name : 'userdata', description : 'Base64 string containing the user data', 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 : 'gpucount', description : 'the count of GPUs on the virtual machine', type : 'integer'}, {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 : 'maxheads', description : 'the maximum number of display heads', 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 : 'userdatapolicy', description : 'The userdata override policy with the userdata provided while deploying Instance', type : 'string'}, {name : 'group', description : 'The group name of the Instance', type : 'string'}, {name : 'isodisplaytext', description : 'An alternate display text of the ISO attached to the Instance', type : 'string'}, {name : 'projectid', description : 'The project 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 : 'isoid', description : 'The ID of the ISO attached to the Instance', type : 'string'}, {name : 'backupofferingid', description : 'The ID of the backup offering of the Instance', type : 'string'}, {name : 'icon', description : 'Base64 string representation of the resource icon', type : 'resourceiconresponse'}, {name : 'videoram', description : 'the video RAM size in MB', type : 'long'}, {name : 'name', description : 'The name of the Instance', type : 'string'}, {name : 'haenable', description : 'True if high-availability is enabled, false otherwise', type : 'boolean'}, {name : 'osdisplayname', description : 'OS name of the Instance', type : 'string'}, {name : 'serviceofferingid', description : 'The ID of the service offering of the Instance', type : 'string'}, {name : 'receivedbytes', description : 'The total number of Network traffic bytes received', type : 'long'}, {name : 'details', description : 'Instance details in key/value pairs.', type : 'map'}, {name : 'securitygroup', description : 'List of security groups associated with the Instance', type : 'set', response : [{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 : 'customer', description : 'Customer 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 : 'value', description : 'Tag value', 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 : '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 : 'project', description : 'The project name where tag belongs to', type : 'string'}]}, {name : 'securitygroupname', description : 'Security group name', 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 : 'icmptype', description : 'The type of the ICMP message response', 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 : '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 : 'domainpath', description : 'path of the Domain the security group belongs to', 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 : '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 : '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 : '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 : '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 : '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 : '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 : 'account', description : 'The Account owning 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 : '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 : 'protocol', description : 'The protocol of the security group rule', type : 'string'}, {name : 'icmptype', description : 'The type of 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 : 'resourceid', description : 'ID of the resource', 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 : '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 : 'customer', description : 'Customer associated with the tag', type : 'string'}, {name : 'key', description : 'Tag key name', 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 : '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 : '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 : 'account', description : 'Account owning the security group rule', type : 'string'}]}]}, {name : 'instancename', description : 'Instance name of the user Instance; this parameter is returned to the ROOT admin only', type : 'string'}, {name : 'pooltype', description : 'The pool type of the Instance', type : 'string'}, {name : 'networkkbsread', description : 'The incoming Network traffic on the Instance in KiB', type : 'long'}, {name : 'deleteprotection', description : 'true if vm has delete protection.', type : 'boolean'}, {name : 'domainid', description : 'The ID of the domain in which the Instance exists', type : 'string'}, {name : 'rootdeviceid', description : 'Device ID of the root volume', type : 'long'}, {name : 'isoname', description : 'The name of the ISO attached to the Instance', type : 'string'}, {name : 'autoscalevmgroupname', description : 'Name of AutoScale Instance group', type : 'string'}, {name : 'domain', description : 'The name of the domain in which the Instance exists', type : 'string'}, {name : 'displayname', description : 'User generated name. The name of the Instance is returned if no displayname exists.', type : 'string'}, {name : 'sentbytes', description : 'The total number of Network traffic bytes sent', type : 'long'}, {name : 'gpucardname', description : 'the name of the gpu card to which service offering is linked', type : 'string'}, {name : 'memory', description : 'The memory allocated for the Instance', type : 'integer'}, {name : 'hasannotations', description : 'True if the entity/resource has annotations', type : 'boolean'}, {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 : 'memorykbs', description : 'The memory used by the Instance in KiB', type : 'long'}, {name : 'publicip', description : 'Public IP address id associated with Instance via Static NAT rule', 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 : '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 : 'affinitygroup', description : 'List of Affinity groups associated with the Instance', type : 'set', response : [{name : 'dedicatedresources', description : 'dedicated resources associated with this affinity group', type : 'list'}, {name : 'id', description : 'The ID of the affinity group', type : 'string'}, {name : 'name', description : 'The name 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 : 'projectid', description : 'The project ID of the affinity group', type : 'string'}, {name : 'domainid', description : 'The domain ID 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 : '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 : 'publicipid', description : 'Public IP address id associated with Instance via Static NAT rule', type : 'string'}, {name : 'boottype', description : 'Guest Instance Boot Type', type : 'string'}, {name : 'created', description : 'The date when this Instance was created', type : 'date'}, {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'}, {name : 'userdatadetails', description : 'List of variables and values for the variables declared in userdata', type : 'string'}, {name : 'userid', description : "The User's ID who deployed the Instance", type : 'string'}, {name : 'zonename', description : 'The name of the availability zone for the Instance', type : 'string'}, {name : 'arch', description : 'CPU arch of the VM', type : 'string'}, {name : 'diskiowrite', description : 'The write (IO) of disk on the Instance', type : 'long'}, {}, {name : 'maxresolutiony', description : 'the maximum Y resolution', type : 'long'}, {name : 'diskkbsread', description : "The Instance's disk read in KiB", type : 'long'}, {name : 'lastupdated', description : 'The date when this Instance was updated last time', type : 'date'}, {name : 'ipaddress', description : "the VM's primary IP address", 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 : 'leaseexpiryaction', description : 'Instance lease expiry action', type : 'string'}, {name : 'jobstatus', description : 'The current status of the latest async job acting on this object', type : 'integer'}, {name : 'forvirtualnetwork', description : 'The virtual Network for the service offering', type : 'boolean'}, {name : 'guestosid', description : 'OS type ID of the Instance', type : 'string'}, {name : 'backupprovider', description : 'The name of the backup provider of the offering attached to the Instance', type : 'string'}, {name : 'id', description : 'The ID of the Instance', type : 'string'}, {}, {name : 'passwordenabled', description : 'True if the password rest feature is enabled, false otherwise', type : 'boolean'}, {name : 'templatedisplaytext', description : 'An alternate display text of the Template for the Instance', type : 'string'}, {name : 'userdataid', description : 'The ID of userdata used for the Instance', type : 'string'}, {name : 'nic', description : 'The list of NICs associated with Instance', type : 'set', response : [{name : 'secondaryip', description : 'The Secondary IPv4 addr of NIC', type : 'list'}, {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 : '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 : 'adaptertype', description : 'Type of adapter if available', type : 'string'}, {name : 'id', description : 'The ID of the NIC', type : 'string'}, {name : 'ip6gateway', description : 'The gateway of IPv6 Network', type : 'string'}, {name : 'gateway', description : 'The gateway of the NIC', 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 : 'netmask', description : 'The netmask 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 : '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 : 'broadcasturi', description : 'The broadcast URI of the NIC', 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 : 'traffictype', description : 'The traffic type of the NIC', type : 'string'}, {name : 'ip6cidr', description : 'The CIDR of IPv6 Network', 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 : '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 : '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 : 'nsxlogicalswitch', description : 'Id of the NSX Logical Switch (if NSX based), null otherwise', 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 : 'extradhcpoption', description : 'The extra DHCP options on the NIC', type : 'list'}, {name : 'ipaddress', description : 'The IP address of the NIC', type : 'string'}, {name : 'ip6address', description : 'The IPv6 address of Network', type : 'string'}]}, {name : 'username', description : "The User's name who deployed the Instance", type : 'string'}, {name : 'vnfnics', description : 'NICs of the VNF appliance', type : 'list'}, {name : 'autoscalevmgroupid', description : 'ID of AutoScale Instance group', type : 'string'}, {name : 'project', description : 'The project name of the Instance', type : 'string'}, {name : 'readonlydetails', description : 'List of read-only Instance details as comma separated string.', 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 : 'project', description : 'The project name where 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 : '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 : 'resourcetype', description : 'Resource type', type : 'string'}, {name : 'key', description : 'Tag key name', type : 'string'}, {name : 'value', description : 'Tag value', type : 'string'}, {name : 'domainid', description : 'The ID of the domain associated with the tag', type : 'string'}]}, {name : 'diskioread', description : 'The read (IO) of disk on the Instance', type : 'long'}, {name : 'vgpuprofilename', description : 'the name of the vgpu profile to which service offering is linked', type : 'string'}, {name : 'bootmode', description : 'Guest Instance Boot Mode', type : 'string'}, {name : 'templatetype', description : 'The type of the template for the virtual machine', type : 'string'}, {name : 'templateformat', description : 'The format of the template for the virtual machine', type : 'string'}], httprequesttype : 'POST'}]
2026-10-27 14:51:13,471 - DEBUG - Payload: {'command': 'listAccounts', 'response': 'json', 'apiKey': 'G1V7YeInTB6ZliRjJwwa0YtCecfo8CcjTIXGYJhvJdMiANFByzv1_tKwcKue4nOQFhcxR0yOq9kGTynSF7xioQ', 'signature': b'5P6GOuM5PBKK++mL/1/1EUn0BUE='}
2026-10-27 14:51:13,471 - DEBUG - ========Sending GET Cmd : listAccounts=======
2026-10-27 14:51:13,518 - DEBUG - Response : [{id : '55be664d-149b-4d60-8c49-8e00c9f038fa', name : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', accounttype : 0, roleid : '496f8f42-3f13-4ba6-bf33-031f66411fb9', roletype : 'User', rolename : 'MarvinFake Role zai21exh9w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:06+0000', user : [{id : '0e59585a-3dc3-49b9-a86c-f81dfa0f4047', username : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:06+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_account_acls_multiple_mgmt_servers-6RB5TP', accounttype : 0, usersource : 'native', roleid : '496f8f42-3f13-4ba6-bf33-031f66411fb9', roletype : 'User', rolename : 'MarvinFake Role zai21exh9w', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', apikey : 'G1V7YeInTB6ZliRjJwwa0YtCecfo8CcjTIXGYJhvJdMiANFByzv1_tKwcKue4nOQFhcxR0yOq9kGTynSF7xioQ', accountid : '55be664d-149b-4d60-8c49-8e00c9f038fa', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : []}]
2026-10-27 14:51:13,518 - DEBUG - Payload: {'command': 'listHosts', 'response': 'json', 'apiKey': 'G1V7YeInTB6ZliRjJwwa0YtCecfo8CcjTIXGYJhvJdMiANFByzv1_tKwcKue4nOQFhcxR0yOq9kGTynSF7xioQ', 'signature': b'xdArQ4tiLh7FxSioFRLc/NlMJ34='}
2026-10-27 14:51:13,518 - DEBUG - ========Sending GET Cmd : listHosts=======
2026-10-27 14:51:13,531 - 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-6RB5TP.\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-6RB5TP.
2026-10-27 14:51:13,532 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.listHosts.listHostsCmd object at 0x7f8d656620d0> 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-6RB5TP.\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-6RB5TP.
2026-10-27 14:51:13,532 - DEBUG - Payload: {'command': 'listZones', 'response': 'json', 'apiKey': 'G1V7YeInTB6ZliRjJwwa0YtCecfo8CcjTIXGYJhvJdMiANFByzv1_tKwcKue4nOQFhcxR0yOq9kGTynSF7xioQ', 'signature': b'VVrc96Jbbph+Z52DWOdnfU/eXjo='}
2026-10-27 14:51:13,532 - DEBUG - ========Sending GET Cmd : listZones=======
2026-10-27 14:51:13,552 - 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-6RB5TP.\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-6RB5TP.
2026-10-27 14:51:13,553 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.listZones.listZonesCmd object at 0x7f8d656626d0> 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-6RB5TP.\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-6RB5TP.
2026-10-27 14:51:13,553 - DEBUG - Payload: {'id': '55be664d-149b-4d60-8c49-8e00c9f038fa', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'OAitP7B4tY0zuSTarJMbh1D2c0I='}
2026-10-27 14:51:13,553 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:13,616 - DEBUG - === Jobid: 845f97bb-05d9-4aaa-ad1f-d6bcd8dec6d9 Started ===
2026-10-27 14:51:13,616 - DEBUG - Payload: {'jobid': '845f97bb-05d9-4aaa-ad1f-d6bcd8dec6d9', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'h4ghWfKb0foJZUHJmHtYhYzi+sc='}
2026-10-27 14:51:13,616 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:13,646 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '55be664d-149b-4d60-8c49-8e00c9f038fa', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:14+0000', jobid : '845f97bb-05d9-4aaa-ad1f-d6bcd8dec6d9', jobstatus : 0}
2026-10-27 14:51:14,648 - DEBUG - === JobId:845f97bb-05d9-4aaa-ad1f-d6bcd8dec6d9 is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:14,648 - DEBUG - Payload: {'jobid': '845f97bb-05d9-4aaa-ad1f-d6bcd8dec6d9', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'h4ghWfKb0foJZUHJmHtYhYzi+sc='}
2026-10-27 14:51:14,648 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:14,735 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '55be664d-149b-4d60-8c49-8e00c9f038fa', created : '2026-10-27T14:51:14+0000', completed : '2026-10-27T14:51:14+0000', jobid : '845f97bb-05d9-4aaa-ad1f-d6bcd8dec6d9', jobstatus : 1}
2026-10-27 14:51:14,736 - DEBUG - ===Jobid:845f97bb-05d9-4aaa-ad1f-d6bcd8dec6d9 ; StartTime:Tue Oct 27 14:51:13 2026 ; EndTime:Tue Oct 27 14:51:14 2026 ; TotalTime:-1===
2026-10-27 14:51:14,736 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '55be664d-149b-4d60-8c49-8e00c9f038fa', created : '2026-10-27T14:51:14+0000', completed : '2026-10-27T14:51:14+0000', jobid : '845f97bb-05d9-4aaa-ad1f-d6bcd8dec6d9', jobstatus : 1}
2026-10-27 14:51:14,736 - DEBUG - Payload: {'id': '700ffd24-4786-4c26-8ce1-e8490d7f9b39', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'A+olrLQiwoXD9QxtNYQgjCU+mUg='}
2026-10-27 14:51:14,736 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:15,814 - DEBUG - Response : {success : True}
2026-10-27 14:51:15,814 - DEBUG - Payload: {'id': '496f8f42-3f13-4ba6-bf33-031f66411fb9', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'PEHEkwO702OKvv2jrdURHzpqNq8='}
2026-10-27 14:51:15,815 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:15,869 - DEBUG - Response : {success : True}
2026-10-27 14:51:15,870 - DEBUG - TestCaseName: test_role_account_acls_multiple_mgmt_servers; Time Taken: 11 Seconds; StartTime: Tue Oct 27 14:51:04 2026; EndTime: Tue Oct 27 14:51:15 2026; Result: SUCCESS
2026-10-27 14:51:15,870 - DEBUG - ::::::::::::STARTED : TC: test_role_inuse_deletion :::::::::::
2026-10-27 14:51:15,871 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:15,871 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:15,905 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:15,905 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role qtpyx7qgvk', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'rIzW3v0qD9xcV/Jb4gANihE1TXE='}
2026-10-27 14:51:15,906 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:15,938 - DEBUG - Response : {type : 'User', state : 'enabled', id : '82062c18-a14e-4812-b956-b4f5c6da0905', name : 'MarvinFake Role qtpyx7qgvk', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:15,939 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '82062c18-a14e-4812-b956-b4f5c6da0905', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mFc7qNAY9byKdDsI8smP7qNwb8Y='}
2026-10-27 14:51:15,939 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:15,999 - DEBUG - Response : {id : 'f5b71091-6557-4494-80bb-84533802191f', roleid : '82062c18-a14e-4812-b956-b4f5c6da0905', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:16,000 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '82062c18-a14e-4812-b956-b4f5c6da0905', 'username': 'rolete-TestDynamicRoles-test_role_inuse_deletion-2WES0B', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'F9Efxy83SYnFDfRmCvtXIGRwFdE='}
2026-10-27 14:51:16,000 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:16,875 - DEBUG - Response : {id : 'c8bef371-6eff-4803-b3d7-db3ca256723d', name : 'rolete-TestDynamicRoles-test_role_inuse_deletion-2WES0B', accounttype : 0, roleid : '82062c18-a14e-4812-b956-b4f5c6da0905', roletype : 'User', rolename : 'MarvinFake Role qtpyx7qgvk', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:17+0000', user : [{id : '25144d83-d509-4ae6-ba1a-7816ba7c54ae', username : 'rolete-TestDynamicRoles-test_role_inuse_deletion-2WES0B', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:17+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_inuse_deletion-2WES0B', accounttype : 0, usersource : 'native', roleid : '82062c18-a14e-4812-b956-b4f5c6da0905', roletype : 'User', rolename : 'MarvinFake Role qtpyx7qgvk', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : 'c8bef371-6eff-4803-b3d7-db3ca256723d', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:16,876 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:16,876 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:16,915 - 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-27 14:51:16,915 - DEBUG - Payload: {'id': '82062c18-a14e-4812-b956-b4f5c6da0905', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'4lYtXAo5h30NkhUyu8rbDs48cck='}
2026-10-27 14:51:16,915 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:16,953 - 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-27 14:51:16,953 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRole.deleteRoleCmd object at 0x7f8d657d79d0> 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-27 14:51:16,953 - DEBUG - Payload: {'id': 'c8bef371-6eff-4803-b3d7-db3ca256723d', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'UhYI7UBuVYt73YHd1454M2AoqPw='}
2026-10-27 14:51:16,953 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:17,000 - DEBUG - === Jobid: d38f0670-9c41-4869-a5cd-c842e8e4bc57 Started ===
2026-10-27 14:51:17,000 - DEBUG - Payload: {'jobid': 'd38f0670-9c41-4869-a5cd-c842e8e4bc57', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'eQbhIvWU61h7E/TdpiRcZ0osCc8='}
2026-10-27 14:51:17,000 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:17,027 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'c8bef371-6eff-4803-b3d7-db3ca256723d', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:17+0000', jobid : 'd38f0670-9c41-4869-a5cd-c842e8e4bc57', jobstatus : 0}
2026-10-27 14:51:18,028 - DEBUG - === JobId:d38f0670-9c41-4869-a5cd-c842e8e4bc57 is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:18,029 - DEBUG - Payload: {'jobid': 'd38f0670-9c41-4869-a5cd-c842e8e4bc57', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'eQbhIvWU61h7E/TdpiRcZ0osCc8='}
2026-10-27 14:51:18,029 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:18,051 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'c8bef371-6eff-4803-b3d7-db3ca256723d', created : '2026-10-27T14:51:17+0000', completed : '2026-10-27T14:51:17+0000', jobid : 'd38f0670-9c41-4869-a5cd-c842e8e4bc57', jobstatus : 1}
2026-10-27 14:51:18,052 - DEBUG - ===Jobid:d38f0670-9c41-4869-a5cd-c842e8e4bc57 ; StartTime:Tue Oct 27 14:51:17 2026 ; EndTime:Tue Oct 27 14:51:18 2026 ; TotalTime:-1===
2026-10-27 14:51:18,052 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'c8bef371-6eff-4803-b3d7-db3ca256723d', created : '2026-10-27T14:51:17+0000', completed : '2026-10-27T14:51:17+0000', jobid : 'd38f0670-9c41-4869-a5cd-c842e8e4bc57', jobstatus : 1}
2026-10-27 14:51:18,052 - DEBUG - Payload: {'id': 'f5b71091-6557-4494-80bb-84533802191f', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'UjloJJ7OARcDeGk0ygEY/SdwkLU='}
2026-10-27 14:51:18,052 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:18,091 - DEBUG - Response : {success : True}
2026-10-27 14:51:18,092 - DEBUG - Payload: {'id': '82062c18-a14e-4812-b956-b4f5c6da0905', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'4lYtXAo5h30NkhUyu8rbDs48cck='}
2026-10-27 14:51:18,092 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:18,128 - DEBUG - Response : {success : True}
2026-10-27 14:51:18,128 - DEBUG - TestCaseName: test_role_inuse_deletion; Time Taken: 2 Seconds; StartTime: Tue Oct 27 14:51:15 2026; EndTime: Tue Oct 27 14:51:18 2026; Result: SUCCESS
2026-10-27 14:51:18,129 - DEBUG - ::::::::::::STARTED : TC: test_role_lifecycle_clone :::::::::::
2026-10-27 14:51:18,129 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:18,129 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:18,153 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:18,153 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role nyqhq79t5b', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'EOPzLwfA5AqBcNDxOeTYA7J+1Vc='}
2026-10-27 14:51:18,153 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:18,197 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'b2e4451d-bbef-4ee8-9b37-a7de9fe30182', name : 'MarvinFake Role nyqhq79t5b', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:18,197 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'b2e4451d-bbef-4ee8-9b37-a7de9fe30182', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'lHQ8oNn3NwBcXTntu327WsWyLfI='}
2026-10-27 14:51:18,198 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:18,232 - DEBUG - Response : {id : '789c8d57-f393-4e2b-99f8-f6c62ea099b8', roleid : 'b2e4451d-bbef-4ee8-9b37-a7de9fe30182', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:18,233 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': 'b2e4451d-bbef-4ee8-9b37-a7de9fe30182', 'username': 'rolete-TestDynamicRoles-test_role_lifecycle_clone-9KE0TB', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'VxJGotAG5mmpzQEvNCSWWvGitI8='}
2026-10-27 14:51:18,234 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:19,045 - DEBUG - Response : {id : 'c52f79e7-79de-40e5-82e6-adaf2d96bd01', name : 'rolete-TestDynamicRoles-test_role_lifecycle_clone-9KE0TB', accounttype : 0, roleid : 'b2e4451d-bbef-4ee8-9b37-a7de9fe30182', roletype : 'User', rolename : 'MarvinFake Role nyqhq79t5b', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:19+0000', user : [{id : '86467e00-9330-4b89-b1c2-5adffbe154c0', username : 'rolete-TestDynamicRoles-test_role_lifecycle_clone-9KE0TB', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:19+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_lifecycle_clone-9KE0TB', accounttype : 0, usersource : 'native', roleid : 'b2e4451d-bbef-4ee8-9b37-a7de9fe30182', roletype : 'User', rolename : 'MarvinFake Role nyqhq79t5b', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : 'c52f79e7-79de-40e5-82e6-adaf2d96bd01', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:19,046 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:19,046 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:19,069 - 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-27 14:51:19,069 - DEBUG - Payload: {'description': 'Fake Role cloned by Marvin test', 'name': 'MarvinFake Clone Role ', 'roleid': 'b2e4451d-bbef-4ee8-9b37-a7de9fe30182', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'bvyrx5bsYxsp5qFDW9FtK7FSpBk='}
2026-10-27 14:51:19,069 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:19,097 - DEBUG - Response : {type : 'User', state : 'enabled', id : '6f6ae565-a770-421c-8fa1-40678405a1f7', name : 'MarvinFake Clone Role ', description : 'Fake Role cloned by Marvin test', ispublic : True}
2026-10-27 14:51:19,097 - DEBUG - Payload: {'id': '6f6ae565-a770-421c-8fa1-40678405a1f7', 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'FqPXM43ASiXbo0jKc7OC0cllv+M='}
2026-10-27 14:51:19,098 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-27 14:51:19,111 - DEBUG - Response : [{type : 'User', isdefault : False, state : 'enabled', id : '6f6ae565-a770-421c-8fa1-40678405a1f7', name : 'MarvinFake Clone Role ', description : 'Fake Role cloned by Marvin test', ispublic : True}]
2026-10-27 14:51:19,112 - DEBUG - Payload: {'roleid': 'b2e4451d-bbef-4ee8-9b37-a7de9fe30182', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'jHt6t63HxQfFPZMc1dWAJk1QB/I='}
2026-10-27 14:51:19,112 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:19,151 - DEBUG - Response : [{id : '789c8d57-f393-4e2b-99f8-f6c62ea099b8', roleid : 'b2e4451d-bbef-4ee8-9b37-a7de9fe30182', rolename : 'MarvinFake Role nyqhq79t5b', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-27 14:51:19,152 - DEBUG - Payload: {'roleid': '6f6ae565-a770-421c-8fa1-40678405a1f7', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'6H7XnFarusbcwKaAhwDgAgUAujU='}
2026-10-27 14:51:19,152 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:19,200 - DEBUG - Response : [{id : 'e88210c3-4e46-4867-8499-96c39e13d6ba', roleid : '6f6ae565-a770-421c-8fa1-40678405a1f7', rolename : 'MarvinFake Clone Role ', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-27 14:51:19,200 - DEBUG - Payload: {'id': 'c52f79e7-79de-40e5-82e6-adaf2d96bd01', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'RpfBBqdCMT6pkLnWV7E/99Gd7ao='}
2026-10-27 14:51:19,200 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:19,269 - DEBUG - === Jobid: 511991c5-69ac-47a7-9a47-f1f3ef5cbaee Started ===
2026-10-27 14:51:19,270 - DEBUG - Payload: {'jobid': '511991c5-69ac-47a7-9a47-f1f3ef5cbaee', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'1fM+Gju6mQTWCyl88+6ME+ajX/I='}
2026-10-27 14:51:19,270 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:19,302 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'c52f79e7-79de-40e5-82e6-adaf2d96bd01', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:19+0000', jobid : '511991c5-69ac-47a7-9a47-f1f3ef5cbaee', jobstatus : 0}
2026-10-27 14:51:20,303 - DEBUG - === JobId:511991c5-69ac-47a7-9a47-f1f3ef5cbaee is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:20,304 - DEBUG - Payload: {'jobid': '511991c5-69ac-47a7-9a47-f1f3ef5cbaee', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'1fM+Gju6mQTWCyl88+6ME+ajX/I='}
2026-10-27 14:51:20,304 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:20,327 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'c52f79e7-79de-40e5-82e6-adaf2d96bd01', created : '2026-10-27T14:51:19+0000', completed : '2026-10-27T14:51:19+0000', jobid : '511991c5-69ac-47a7-9a47-f1f3ef5cbaee', jobstatus : 1}
2026-10-27 14:51:20,328 - DEBUG - ===Jobid:511991c5-69ac-47a7-9a47-f1f3ef5cbaee ; StartTime:Tue Oct 27 14:51:19 2026 ; EndTime:Tue Oct 27 14:51:20 2026 ; TotalTime:-1===
2026-10-27 14:51:20,328 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'c52f79e7-79de-40e5-82e6-adaf2d96bd01', created : '2026-10-27T14:51:19+0000', completed : '2026-10-27T14:51:19+0000', jobid : '511991c5-69ac-47a7-9a47-f1f3ef5cbaee', jobstatus : 1}
2026-10-27 14:51:20,328 - DEBUG - Payload: {'id': '789c8d57-f393-4e2b-99f8-f6c62ea099b8', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'N82B8jELPLQUY+w9QU0ic5pkWfo='}
2026-10-27 14:51:20,329 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:20,359 - DEBUG - Response : {success : True}
2026-10-27 14:51:20,360 - DEBUG - Payload: {'id': 'b2e4451d-bbef-4ee8-9b37-a7de9fe30182', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Ue5v9JI4b6W5A5uWSohvFeG0UAU='}
2026-10-27 14:51:20,360 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:20,387 - DEBUG - Response : {success : True}
2026-10-27 14:51:20,387 - DEBUG - Payload: {'id': '6f6ae565-a770-421c-8fa1-40678405a1f7', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'afU5fUINyp5ihapH7M3ezIKhiKc='}
2026-10-27 14:51:20,387 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:20,416 - DEBUG - Response : {success : True}
2026-10-27 14:51:20,417 - DEBUG - TestCaseName: test_role_lifecycle_clone; Time Taken: 2 Seconds; StartTime: Tue Oct 27 14:51:18 2026; EndTime: Tue Oct 27 14:51:20 2026; Result: SUCCESS
2026-10-27 14:51:20,417 - DEBUG - ::::::::::::STARTED : TC: test_role_lifecycle_create :::::::::::
2026-10-27 14:51:20,418 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:20,418 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:20,444 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:20,445 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role q4pcteuos3', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'jOdgbgiQzonnWZbjUWGXCcPWTTM='}
2026-10-27 14:51:20,445 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:20,474 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'd7e6a665-3459-418d-9c87-0be41e12c71d', name : 'MarvinFake Role q4pcteuos3', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:20,475 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'd7e6a665-3459-418d-9c87-0be41e12c71d', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'7bcBMFysm6ZB6Q7vNMYIovcaxS8='}
2026-10-27 14:51:20,475 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:20,509 - DEBUG - Response : {id : '6fca9a1d-b3be-470f-a4d3-bb207eda1681', roleid : 'd7e6a665-3459-418d-9c87-0be41e12c71d', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:20,509 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': 'd7e6a665-3459-418d-9c87-0be41e12c71d', 'username': 'rolete-TestDynamicRoles-test_role_lifecycle_create-41Q266', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Q4toWgkLqYCghGaGDaH9oi2Qda4='}
2026-10-27 14:51:20,510 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:21,323 - DEBUG - Response : {id : 'effae3a1-8f50-4cd4-9cbf-691d3d65c31a', name : 'rolete-TestDynamicRoles-test_role_lifecycle_create-41Q266', accounttype : 0, roleid : 'd7e6a665-3459-418d-9c87-0be41e12c71d', roletype : 'User', rolename : 'MarvinFake Role q4pcteuos3', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:21+0000', user : [{id : 'ac541e38-73ad-499b-be97-a674df31162b', username : 'rolete-TestDynamicRoles-test_role_lifecycle_create-41Q266', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:21+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_lifecycle_create-41Q266', accounttype : 0, usersource : 'native', roleid : 'd7e6a665-3459-418d-9c87-0be41e12c71d', roletype : 'User', rolename : 'MarvinFake Role q4pcteuos3', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : 'effae3a1-8f50-4cd4-9cbf-691d3d65c31a', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:21,324 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:21,325 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:21,357 - 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-27 14:51:21,358 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role q4pcteuos3', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'jOdgbgiQzonnWZbjUWGXCcPWTTM='}
2026-10-27 14:51:21,358 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:21,400 - 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-27 14:51:21,400 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.createRole.createRoleCmd object at 0x7f8d657d7c10> 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-27 14:51:21,401 - DEBUG - Payload: {'id': 'd7e6a665-3459-418d-9c87-0be41e12c71d', 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'LNcup2CUZojHYstyvUKXDWaqXXU='}
2026-10-27 14:51:21,401 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-27 14:51:21,425 - DEBUG - Response : [{type : 'User', isdefault : False, state : 'enabled', id : 'd7e6a665-3459-418d-9c87-0be41e12c71d', name : 'MarvinFake Role q4pcteuos3', description : 'Fake Role created by Marvin test', ispublic : True}]
2026-10-27 14:51:21,426 - DEBUG - Payload: {'id': 'effae3a1-8f50-4cd4-9cbf-691d3d65c31a', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'NJiTpJpB9ZE8MfA1EKwIQGVoiS8='}
2026-10-27 14:51:21,426 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:21,472 - DEBUG - === Jobid: 4a656cd7-41d3-47b9-832b-0ab4ea3c2c86 Started ===
2026-10-27 14:51:21,473 - DEBUG - Payload: {'jobid': '4a656cd7-41d3-47b9-832b-0ab4ea3c2c86', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'woANQG24iqnYV/zRqmHiYvj449s='}
2026-10-27 14:51:21,473 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:21,505 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'effae3a1-8f50-4cd4-9cbf-691d3d65c31a', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:21+0000', jobid : '4a656cd7-41d3-47b9-832b-0ab4ea3c2c86', jobstatus : 0}
2026-10-27 14:51:22,507 - DEBUG - === JobId:4a656cd7-41d3-47b9-832b-0ab4ea3c2c86 is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:22,507 - DEBUG - Payload: {'jobid': '4a656cd7-41d3-47b9-832b-0ab4ea3c2c86', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'woANQG24iqnYV/zRqmHiYvj449s='}
2026-10-27 14:51:22,507 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:22,534 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'effae3a1-8f50-4cd4-9cbf-691d3d65c31a', created : '2026-10-27T14:51:21+0000', completed : '2026-10-27T14:51:22+0000', jobid : '4a656cd7-41d3-47b9-832b-0ab4ea3c2c86', jobstatus : 1}
2026-10-27 14:51:22,534 - DEBUG - ===Jobid:4a656cd7-41d3-47b9-832b-0ab4ea3c2c86 ; StartTime:Tue Oct 27 14:51:21 2026 ; EndTime:Tue Oct 27 14:51:22 2026 ; TotalTime:-1===
2026-10-27 14:51:22,535 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'effae3a1-8f50-4cd4-9cbf-691d3d65c31a', created : '2026-10-27T14:51:21+0000', completed : '2026-10-27T14:51:22+0000', jobid : '4a656cd7-41d3-47b9-832b-0ab4ea3c2c86', jobstatus : 1}
2026-10-27 14:51:22,535 - DEBUG - Payload: {'id': '6fca9a1d-b3be-470f-a4d3-bb207eda1681', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'nYYfAGNKqrgSHsZ1+rLy5SbMWOw='}
2026-10-27 14:51:22,535 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:22,565 - DEBUG - Response : {success : True}
2026-10-27 14:51:22,565 - DEBUG - Payload: {'id': 'd7e6a665-3459-418d-9c87-0be41e12c71d', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'IXQx1Kmp0NzcHYq6HM6HnBpoy7k='}
2026-10-27 14:51:22,565 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:22,595 - DEBUG - Response : {success : True}
2026-10-27 14:51:22,596 - DEBUG - TestCaseName: test_role_lifecycle_create; Time Taken: 2 Seconds; StartTime: Tue Oct 27 14:51:20 2026; EndTime: Tue Oct 27 14:51:22 2026; Result: SUCCESS
2026-10-27 14:51:22,596 - DEBUG - ::::::::::::STARTED : TC: test_role_lifecycle_delete :::::::::::
2026-10-27 14:51:22,597 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:22,597 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:22,626 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:22,627 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role oi6fjd8l8t', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'GubA5JfABaBLHghzXGdH/X90Ae8='}
2026-10-27 14:51:22,627 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:22,653 - DEBUG - Response : {type : 'User', state : 'enabled', id : '2f249781-5804-4e43-ae8d-b8cc80b6f0fe', name : 'MarvinFake Role oi6fjd8l8t', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:22,654 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '2f249781-5804-4e43-ae8d-b8cc80b6f0fe', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'knJQfWeuS3a15rVri8K6FNBHsRU='}
2026-10-27 14:51:22,654 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:22,682 - DEBUG - Response : {id : 'c2fd1263-3c0e-4d52-b778-48b354bcc6d4', roleid : '2f249781-5804-4e43-ae8d-b8cc80b6f0fe', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:22,683 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '2f249781-5804-4e43-ae8d-b8cc80b6f0fe', 'username': 'rolete-TestDynamicRoles-test_role_lifecycle_delete-ZLSUI7', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'd4yzh2hCKzmkA69xjrApPsZa0Go='}
2026-10-27 14:51:22,683 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:23,544 - DEBUG - Response : {id : 'fde82ecf-7290-41d2-82f2-017595ace057', name : 'rolete-TestDynamicRoles-test_role_lifecycle_delete-ZLSUI7', accounttype : 0, roleid : '2f249781-5804-4e43-ae8d-b8cc80b6f0fe', roletype : 'User', rolename : 'MarvinFake Role oi6fjd8l8t', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:23+0000', user : [{id : '6d1bcb35-b985-4367-bd32-197f451564a7', username : 'rolete-TestDynamicRoles-test_role_lifecycle_delete-ZLSUI7', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:24+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_lifecycle_delete-ZLSUI7', accounttype : 0, usersource : 'native', roleid : '2f249781-5804-4e43-ae8d-b8cc80b6f0fe', roletype : 'User', rolename : 'MarvinFake Role oi6fjd8l8t', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : 'fde82ecf-7290-41d2-82f2-017595ace057', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:23,545 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:23,545 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:23,569 - 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-27 14:51:23,570 - DEBUG - Payload: {'id': 'fde82ecf-7290-41d2-82f2-017595ace057', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ks+7silwvHD6OgLtPHCk4pm8lZ4='}
2026-10-27 14:51:23,570 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:23,603 - DEBUG - === Jobid: 83b5997c-3271-465a-af2e-bdc1b650a674 Started ===
2026-10-27 14:51:23,603 - DEBUG - Payload: {'jobid': '83b5997c-3271-465a-af2e-bdc1b650a674', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'puCriRjoYKPbghp8ZYqJHqWGvVM='}
2026-10-27 14:51:23,603 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:23,626 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'fde82ecf-7290-41d2-82f2-017595ace057', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:24+0000', jobid : '83b5997c-3271-465a-af2e-bdc1b650a674', jobstatus : 0}
2026-10-27 14:51:24,628 - DEBUG - === JobId:83b5997c-3271-465a-af2e-bdc1b650a674 is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:24,628 - DEBUG - Payload: {'jobid': '83b5997c-3271-465a-af2e-bdc1b650a674', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'puCriRjoYKPbghp8ZYqJHqWGvVM='}
2026-10-27 14:51:24,629 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:24,652 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'fde82ecf-7290-41d2-82f2-017595ace057', created : '2026-10-27T14:51:24+0000', completed : '2026-10-27T14:51:24+0000', jobid : '83b5997c-3271-465a-af2e-bdc1b650a674', jobstatus : 1}
2026-10-27 14:51:24,652 - DEBUG - ===Jobid:83b5997c-3271-465a-af2e-bdc1b650a674 ; StartTime:Tue Oct 27 14:51:23 2026 ; EndTime:Tue Oct 27 14:51:24 2026 ; TotalTime:-1===
2026-10-27 14:51:24,652 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'fde82ecf-7290-41d2-82f2-017595ace057', created : '2026-10-27T14:51:24+0000', completed : '2026-10-27T14:51:24+0000', jobid : '83b5997c-3271-465a-af2e-bdc1b650a674', jobstatus : 1}
2026-10-27 14:51:24,653 - DEBUG - Payload: {'id': '2f249781-5804-4e43-ae8d-b8cc80b6f0fe', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'sUmKzhQfYtRPBAlqGA6TX+PJxvg='}
2026-10-27 14:51:24,653 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:24,691 - DEBUG - Response : {success : True}
2026-10-27 14:51:24,691 - DEBUG - Payload: {'id': '2f249781-5804-4e43-ae8d-b8cc80b6f0fe', 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'LkQiXf4mA9Ou3F01CflxCtVSW4A='}
2026-10-27 14:51:24,692 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-27 14:51:24,712 - DEBUG - Response : None
2026-10-27 14:51:24,713 - DEBUG - Payload: {'id': 'fde82ecf-7290-41d2-82f2-017595ace057', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ks+7silwvHD6OgLtPHCk4pm8lZ4='}
2026-10-27 14:51:24,713 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:24,744 - DEBUG - === Jobid: d3021b6b-0910-46a2-9b13-20fae2f1f304 Started ===
2026-10-27 14:51:24,744 - DEBUG - Payload: {'jobid': 'd3021b6b-0910-46a2-9b13-20fae2f1f304', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'xd9S+GhkdURh3G4HhYAUv5MLrmg='}
2026-10-27 14:51:24,744 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:24,772 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'fde82ecf-7290-41d2-82f2-017595ace057', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:25+0000', jobid : 'd3021b6b-0910-46a2-9b13-20fae2f1f304', jobstatus : 0}
2026-10-27 14:51:25,774 - DEBUG - === JobId:d3021b6b-0910-46a2-9b13-20fae2f1f304 is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:25,774 - DEBUG - Payload: {'jobid': 'd3021b6b-0910-46a2-9b13-20fae2f1f304', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'xd9S+GhkdURh3G4HhYAUv5MLrmg='}
2026-10-27 14:51:25,774 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:25,806 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'fde82ecf-7290-41d2-82f2-017595ace057', created : '2026-10-27T14:51:25+0000', completed : '2026-10-27T14:51:25+0000', jobid : 'd3021b6b-0910-46a2-9b13-20fae2f1f304', jobstatus : 1}
2026-10-27 14:51:25,806 - DEBUG - ===Jobid:d3021b6b-0910-46a2-9b13-20fae2f1f304 ; StartTime:Tue Oct 27 14:51:24 2026 ; EndTime:Tue Oct 27 14:51:25 2026 ; TotalTime:-1===
2026-10-27 14:51:25,806 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'fde82ecf-7290-41d2-82f2-017595ace057', created : '2026-10-27T14:51:25+0000', completed : '2026-10-27T14:51:25+0000', jobid : 'd3021b6b-0910-46a2-9b13-20fae2f1f304', jobstatus : 1}
2026-10-27 14:51:25,807 - DEBUG - Payload: {'id': 'c2fd1263-3c0e-4d52-b778-48b354bcc6d4', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'hWLS5nHlrZV3bkNZnuElu9xAtRU='}
2026-10-27 14:51:25,807 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:25,824 - 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=c2fd1263-3c0e-4d52-b778-48b354bcc6d4 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=c2fd1263-3c0e-4d52-b778-48b354bcc6d4 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-27 14:51:25,824 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRolePermission.deleteRolePermissionCmd object at 0x7f8d657d6e80> 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=c2fd1263-3c0e-4d52-b778-48b354bcc6d4 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=c2fd1263-3c0e-4d52-b778-48b354bcc6d4 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-27 14:51:25,825 - 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=c2fd1263-3c0e-4d52-b778-48b354bcc6d4 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-27 14:51:25,825 - DEBUG - TestCaseName: test_role_lifecycle_delete; Time Taken: 3 Seconds; StartTime: Tue Oct 27 14:51:22 2026; EndTime: Tue Oct 27 14:51:25 2026; Result: SUCCESS
2026-10-27 14:51:25,825 - DEBUG - ::::::::::::STARTED : TC: test_role_lifecycle_import :::::::::::
2026-10-27 14:51:25,826 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:25,826 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:25,856 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:25,856 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role 04dbnvo63q', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AO0cmbuK8GuQEuMQVwK7TryI1jw='}
2026-10-27 14:51:25,856 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:25,892 - DEBUG - Response : {type : 'User', state : 'enabled', id : '870f63ee-4de7-4cda-a75b-5b55b21430fc', name : 'MarvinFake Role 04dbnvo63q', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:25,892 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '870f63ee-4de7-4cda-a75b-5b55b21430fc', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'eX667t0IzQNDGvDpaC3fus5MM/c='}
2026-10-27 14:51:25,892 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:25,932 - DEBUG - Response : {id : 'c1421478-a8df-4b36-8342-df802987f6ae', roleid : '870f63ee-4de7-4cda-a75b-5b55b21430fc', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:25,933 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '870f63ee-4de7-4cda-a75b-5b55b21430fc', 'username': 'rolete-TestDynamicRoles-test_role_lifecycle_import-1R44F8', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'MymGhkDaZFF47B1RajmtXTdC5u4='}
2026-10-27 14:51:25,934 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:26,912 - DEBUG - Response : {id : '8cd2fb79-c493-4d84-8367-66004fa0e013', name : 'rolete-TestDynamicRoles-test_role_lifecycle_import-1R44F8', accounttype : 0, roleid : '870f63ee-4de7-4cda-a75b-5b55b21430fc', roletype : 'User', rolename : 'MarvinFake Role 04dbnvo63q', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:27+0000', user : [{id : 'e756b403-34ea-4be4-b308-4184c27961cc', username : 'rolete-TestDynamicRoles-test_role_lifecycle_import-1R44F8', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:27+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_lifecycle_import-1R44F8', accounttype : 0, usersource : 'native', roleid : '870f63ee-4de7-4cda-a75b-5b55b21430fc', roletype : 'User', rolename : 'MarvinFake Role 04dbnvo63q', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : '8cd2fb79-c493-4d84-8367-66004fa0e013', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:26,912 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:26,912 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:26,933 - 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-27 14:51:26,933 - DEBUG - Payload: {'description': 'Fake Import User Role created by Marvin test', 'name': 'MarvinFake Import Role 4xocxx4mn5', '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'riUmG4Q45LRTd8HqR2BQuzmVvtk='}
2026-10-27 14:51:26,933 - DEBUG - ========Sending GET Cmd : importRole=======
2026-10-27 14:51:26,971 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'ad963061-ccf2-4abf-b53a-f50c0700aebf', name : 'MarvinFake Import Role 4xocxx4mn5', description : 'Fake Import User Role created by Marvin test', ispublic : True}
2026-10-27 14:51:26,972 - DEBUG - Payload: {'id': 'ad963061-ccf2-4abf-b53a-f50c0700aebf', 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'i/ZFRrZqwOvUjOPSQgL16ukmjHk='}
2026-10-27 14:51:26,972 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-27 14:51:26,989 - DEBUG - Response : [{type : 'User', isdefault : False, state : 'enabled', id : 'ad963061-ccf2-4abf-b53a-f50c0700aebf', name : 'MarvinFake Import Role 4xocxx4mn5', description : 'Fake Import User Role created by Marvin test', ispublic : True}]
2026-10-27 14:51:26,990 - DEBUG - Payload: {'roleid': 'ad963061-ccf2-4abf-b53a-f50c0700aebf', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'P7nUNtv9yhdV2CxisL4HhPJVNos='}
2026-10-27 14:51:26,991 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:27,012 - DEBUG - Response : [{id : '7c6ad332-f293-4ba4-ab5e-d8cc0cd32623', roleid : 'ad963061-ccf2-4abf-b53a-f50c0700aebf', rolename : 'MarvinFake Import Role 4xocxx4mn5', rule : 'list*', permission : 'allow', description : 'Listing apis'}, {id : '663fbe06-6dbd-49d8-af1b-fbba40963462', roleid : 'ad963061-ccf2-4abf-b53a-f50c0700aebf', rolename : 'MarvinFake Import Role 4xocxx4mn5', rule : 'get*', permission : 'allow', description : 'Get apis'}, {id : '2bc611d4-c77b-4e94-8141-6954c855021a', roleid : 'ad963061-ccf2-4abf-b53a-f50c0700aebf', rolename : 'MarvinFake Import Role 4xocxx4mn5', rule : 'update*', permission : 'deny', description : 'Update apis'}]
2026-10-27 14:51:27,013 - DEBUG - Payload: {'id': '8cd2fb79-c493-4d84-8367-66004fa0e013', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'wstE11NAf0AzNZc2AzwiCGQaj34='}
2026-10-27 14:51:27,013 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:27,046 - DEBUG - === Jobid: 1bee0856-c2c3-414b-a3f6-42889dc7cde8 Started ===
2026-10-27 14:51:27,047 - DEBUG - Payload: {'jobid': '1bee0856-c2c3-414b-a3f6-42889dc7cde8', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'63fz2NjUFgH3ETYgs02cwrxVFbU='}
2026-10-27 14:51:27,047 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:27,066 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '8cd2fb79-c493-4d84-8367-66004fa0e013', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:27+0000', jobid : '1bee0856-c2c3-414b-a3f6-42889dc7cde8', jobstatus : 0}
2026-10-27 14:51:28,068 - DEBUG - === JobId:1bee0856-c2c3-414b-a3f6-42889dc7cde8 is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:28,069 - DEBUG - Payload: {'jobid': '1bee0856-c2c3-414b-a3f6-42889dc7cde8', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'63fz2NjUFgH3ETYgs02cwrxVFbU='}
2026-10-27 14:51:28,069 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:28,100 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '8cd2fb79-c493-4d84-8367-66004fa0e013', created : '2026-10-27T14:51:27+0000', completed : '2026-10-27T14:51:27+0000', jobid : '1bee0856-c2c3-414b-a3f6-42889dc7cde8', jobstatus : 1}
2026-10-27 14:51:28,100 - DEBUG - ===Jobid:1bee0856-c2c3-414b-a3f6-42889dc7cde8 ; StartTime:Tue Oct 27 14:51:27 2026 ; EndTime:Tue Oct 27 14:51:28 2026 ; TotalTime:-1===
2026-10-27 14:51:28,100 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '8cd2fb79-c493-4d84-8367-66004fa0e013', created : '2026-10-27T14:51:27+0000', completed : '2026-10-27T14:51:27+0000', jobid : '1bee0856-c2c3-414b-a3f6-42889dc7cde8', jobstatus : 1}
2026-10-27 14:51:28,100 - DEBUG - Payload: {'id': 'c1421478-a8df-4b36-8342-df802987f6ae', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'7GLZh8NdQGsyJ16Nh3IPrCWfXIs='}
2026-10-27 14:51:28,101 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:28,130 - DEBUG - Response : {success : True}
2026-10-27 14:51:28,130 - DEBUG - Payload: {'id': '870f63ee-4de7-4cda-a75b-5b55b21430fc', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'fXD5zLr/8AkIwC00CQsLHKFEe6I='}
2026-10-27 14:51:28,131 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:28,160 - DEBUG - Response : {success : True}
2026-10-27 14:51:28,161 - DEBUG - Payload: {'id': 'ad963061-ccf2-4abf-b53a-f50c0700aebf', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'YpJn7Rh0BIQyeldwkbupqgSr8Ro='}
2026-10-27 14:51:28,161 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:28,185 - DEBUG - Response : {success : True}
2026-10-27 14:51:28,186 - DEBUG - TestCaseName: test_role_lifecycle_import; Time Taken: 2 Seconds; StartTime: Tue Oct 27 14:51:25 2026; EndTime: Tue Oct 27 14:51:28 2026; Result: SUCCESS
2026-10-27 14:51:28,187 - DEBUG - ::::::::::::STARTED : TC: test_role_lifecycle_list :::::::::::
2026-10-27 14:51:28,187 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:28,187 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:28,213 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:28,214 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role l2sz48bish', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ck3A//4uRNYu3vLi6JvCZ6Nr+zc='}
2026-10-27 14:51:28,214 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:28,245 - DEBUG - Response : {type : 'User', state : 'enabled', id : '7957dfd3-8271-4550-be52-36b8169291a6', name : 'MarvinFake Role l2sz48bish', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:28,246 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '7957dfd3-8271-4550-be52-36b8169291a6', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'yBaO153yDMFk8cxXPPA+davGy/4='}
2026-10-27 14:51:28,246 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:28,294 - DEBUG - Response : {id : '9672ec6c-fb15-40b5-9a8b-dab77a15e83c', roleid : '7957dfd3-8271-4550-be52-36b8169291a6', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:28,295 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '7957dfd3-8271-4550-be52-36b8169291a6', 'username': 'rolete-TestDynamicRoles-test_role_lifecycle_list-L7EMPK', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b't3LddGQptXUKVakt8HPqnl1FGfs='}
2026-10-27 14:51:28,295 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:29,247 - DEBUG - Response : {id : '2af8d155-173a-451e-9bcb-3ad3887fb0e3', name : 'rolete-TestDynamicRoles-test_role_lifecycle_list-L7EMPK', accounttype : 0, roleid : '7957dfd3-8271-4550-be52-36b8169291a6', roletype : 'User', rolename : 'MarvinFake Role l2sz48bish', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:29+0000', user : [{id : '7fe70642-c94f-4e6a-bbee-833bfa3b11c6', username : 'rolete-TestDynamicRoles-test_role_lifecycle_list-L7EMPK', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:29+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_lifecycle_list-L7EMPK', accounttype : 0, usersource : 'native', roleid : '7957dfd3-8271-4550-be52-36b8169291a6', roletype : 'User', rolename : 'MarvinFake Role l2sz48bish', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : '2af8d155-173a-451e-9bcb-3ad3887fb0e3', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:29,248 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:29,248 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:29,268 - 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-27 14:51:29,268 - DEBUG - Payload: {'id': 1, 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'w6YGHTmNTwIIz0GfuTutO4e6fjs='}
2026-10-27 14:51:29,269 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-27 14:51:29,282 - DEBUG - Response : [{type : 'Admin', isdefault : True, state : 'enabled', id : '87d83eed-d1fe-11f1-81aa-1e0044000301', name : 'Root Admin', description : 'Default root admin role', ispublic : True}]
2026-10-27 14:51:29,283 - DEBUG - Payload: {'id': 2, 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'0ASzjui3BusnYz90AWsKakeXIuE='}
2026-10-27 14:51:29,283 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-27 14:51:29,298 - DEBUG - Response : [{type : 'ResourceAdmin', isdefault : True, state : 'enabled', id : '87d8715d-d1fe-11f1-81aa-1e0044000301', name : 'Resource Admin', description : 'Default resource admin role', ispublic : True}]
2026-10-27 14:51:29,298 - DEBUG - Payload: {'id': 3, 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'k1yb56EzUPeAaYALLNSox3vcFKY='}
2026-10-27 14:51:29,299 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-27 14:51:29,311 - DEBUG - Response : [{type : 'DomainAdmin', isdefault : True, state : 'enabled', id : '87d88360-d1fe-11f1-81aa-1e0044000301', name : 'Domain Admin', description : 'Default domain admin role', ispublic : True}]
2026-10-27 14:51:29,312 - DEBUG - Payload: {'id': 4, 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'jl2J3GOJgIBKjnL3dgB6SGPYntc='}
2026-10-27 14:51:29,312 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-27 14:51:29,326 - DEBUG - Response : [{type : 'User', isdefault : True, state : 'enabled', id : '87d88f8c-d1fe-11f1-81aa-1e0044000301', name : 'User', description : 'Default user role', ispublic : True}]
2026-10-27 14:51:29,327 - DEBUG - Payload: {'id': '2af8d155-173a-451e-9bcb-3ad3887fb0e3', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'2FyW4qerbVH3WHPTrus2PZMVn3s='}
2026-10-27 14:51:29,327 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:29,359 - DEBUG - === Jobid: d7ba3e1d-ac98-4ca2-a3df-20e5dd52fc56 Started ===
2026-10-27 14:51:29,359 - DEBUG - Payload: {'jobid': 'd7ba3e1d-ac98-4ca2-a3df-20e5dd52fc56', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'lKCYiZ8t4jiDaEGvHd8MtL6Hsp0='}
2026-10-27 14:51:29,359 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:29,385 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '2af8d155-173a-451e-9bcb-3ad3887fb0e3', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:29+0000', jobid : 'd7ba3e1d-ac98-4ca2-a3df-20e5dd52fc56', jobstatus : 0}
2026-10-27 14:51:30,387 - DEBUG - === JobId:d7ba3e1d-ac98-4ca2-a3df-20e5dd52fc56 is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:30,388 - DEBUG - Payload: {'jobid': 'd7ba3e1d-ac98-4ca2-a3df-20e5dd52fc56', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'lKCYiZ8t4jiDaEGvHd8MtL6Hsp0='}
2026-10-27 14:51:30,388 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:30,420 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '2af8d155-173a-451e-9bcb-3ad3887fb0e3', created : '2026-10-27T14:51:29+0000', completed : '2026-10-27T14:51:29+0000', jobid : 'd7ba3e1d-ac98-4ca2-a3df-20e5dd52fc56', jobstatus : 1}
2026-10-27 14:51:30,420 - DEBUG - ===Jobid:d7ba3e1d-ac98-4ca2-a3df-20e5dd52fc56 ; StartTime:Tue Oct 27 14:51:29 2026 ; EndTime:Tue Oct 27 14:51:30 2026 ; TotalTime:-1===
2026-10-27 14:51:30,421 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '2af8d155-173a-451e-9bcb-3ad3887fb0e3', created : '2026-10-27T14:51:29+0000', completed : '2026-10-27T14:51:29+0000', jobid : 'd7ba3e1d-ac98-4ca2-a3df-20e5dd52fc56', jobstatus : 1}
2026-10-27 14:51:30,421 - DEBUG - Payload: {'id': '9672ec6c-fb15-40b5-9a8b-dab77a15e83c', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'43Ea34VYaZwqb/WSaTs4PbUL/JY='}
2026-10-27 14:51:30,422 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:30,452 - DEBUG - Response : {success : True}
2026-10-27 14:51:30,452 - DEBUG - Payload: {'id': '7957dfd3-8271-4550-be52-36b8169291a6', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'UkGe0pHGgQidek7UBzwjnSwGEhg='}
2026-10-27 14:51:30,452 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:30,479 - DEBUG - Response : {success : True}
2026-10-27 14:51:30,480 - DEBUG - TestCaseName: test_role_lifecycle_list; Time Taken: 2 Seconds; StartTime: Tue Oct 27 14:51:28 2026; EndTime: Tue Oct 27 14:51:30 2026; Result: SUCCESS
2026-10-27 14:51:30,480 - DEBUG - ::::::::::::STARTED : TC: test_role_lifecycle_update :::::::::::
2026-10-27 14:51:30,481 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:30,481 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:30,500 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:30,501 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role cvsx26lv2m', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'1aXkMRhMTlbZN9bOtaPnyzTKGn0='}
2026-10-27 14:51:30,501 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:30,528 - DEBUG - Response : {type : 'User', state : 'enabled', id : '8cb60005-a2e6-4c5e-8922-5992a5b8abda', name : 'MarvinFake Role cvsx26lv2m', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:30,529 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '8cb60005-a2e6-4c5e-8922-5992a5b8abda', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'XAA+SFveMP80TAVW5mpzk+7RJkM='}
2026-10-27 14:51:30,529 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:30,569 - DEBUG - Response : {id : 'a658da59-817b-4e21-807b-f8d6af16ae67', roleid : '8cb60005-a2e6-4c5e-8922-5992a5b8abda', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:30,570 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '8cb60005-a2e6-4c5e-8922-5992a5b8abda', 'username': 'rolete-TestDynamicRoles-test_role_lifecycle_update-VD8BME', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'VubTxetVf+XKxddLReqMhQQy00g='}
2026-10-27 14:51:30,570 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:31,416 - DEBUG - Response : {id : 'e7240cf3-45a9-4bf9-9c5e-b4eea396eb51', name : 'rolete-TestDynamicRoles-test_role_lifecycle_update-VD8BME', accounttype : 0, roleid : '8cb60005-a2e6-4c5e-8922-5992a5b8abda', roletype : 'User', rolename : 'MarvinFake Role cvsx26lv2m', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:31+0000', user : [{id : 'ab3f3941-4634-4621-a9e1-056e616cb9ac', username : 'rolete-TestDynamicRoles-test_role_lifecycle_update-VD8BME', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:31+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_lifecycle_update-VD8BME', accounttype : 0, usersource : 'native', roleid : '8cb60005-a2e6-4c5e-8922-5992a5b8abda', roletype : 'User', rolename : 'MarvinFake Role cvsx26lv2m', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : 'e7240cf3-45a9-4bf9-9c5e-b4eea396eb51', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:31,416 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:31,416 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:31,434 - 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-27 14:51:31,435 - DEBUG - Payload: {'id': 'e7240cf3-45a9-4bf9-9c5e-b4eea396eb51', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'x2xLoIp2f9Kjpoo/KrfIsn2fYbE='}
2026-10-27 14:51:31,435 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:31,462 - DEBUG - === Jobid: 28101eba-8fb5-41cd-8723-3815cd6f3a7f Started ===
2026-10-27 14:51:31,462 - DEBUG - Payload: {'jobid': '28101eba-8fb5-41cd-8723-3815cd6f3a7f', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'NWPKr8l1IPz4Ws2ag2rIf+/ObYY='}
2026-10-27 14:51:31,462 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:31,488 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'e7240cf3-45a9-4bf9-9c5e-b4eea396eb51', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:31+0000', jobid : '28101eba-8fb5-41cd-8723-3815cd6f3a7f', jobstatus : 0}
2026-10-27 14:51:32,489 - DEBUG - === JobId:28101eba-8fb5-41cd-8723-3815cd6f3a7f is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:32,490 - DEBUG - Payload: {'jobid': '28101eba-8fb5-41cd-8723-3815cd6f3a7f', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'NWPKr8l1IPz4Ws2ag2rIf+/ObYY='}
2026-10-27 14:51:32,490 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:32,515 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'e7240cf3-45a9-4bf9-9c5e-b4eea396eb51', created : '2026-10-27T14:51:31+0000', completed : '2026-10-27T14:51:32+0000', jobid : '28101eba-8fb5-41cd-8723-3815cd6f3a7f', jobstatus : 1}
2026-10-27 14:51:32,515 - DEBUG - ===Jobid:28101eba-8fb5-41cd-8723-3815cd6f3a7f ; StartTime:Tue Oct 27 14:51:31 2026 ; EndTime:Tue Oct 27 14:51:32 2026 ; TotalTime:-1===
2026-10-27 14:51:32,516 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'e7240cf3-45a9-4bf9-9c5e-b4eea396eb51', created : '2026-10-27T14:51:31+0000', completed : '2026-10-27T14:51:32+0000', jobid : '28101eba-8fb5-41cd-8723-3815cd6f3a7f', jobstatus : 1}
2026-10-27 14:51:32,516 - DEBUG - Payload: {'description': 'Fake role description created after update', 'id': '8cb60005-a2e6-4c5e-8922-5992a5b8abda', 'name': 'MarvinFakeRoleNewName-gn7jizndqm', 'type': 'Admin', 'command': 'updateRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'zTBfF+laQpVFRl5AhMkAmCUFkb0='}
2026-10-27 14:51:32,516 - DEBUG - ========Sending GET Cmd : updateRole=======
2026-10-27 14:51:32,558 - DEBUG - Response : {type : 'Admin', state : 'enabled', id : '8cb60005-a2e6-4c5e-8922-5992a5b8abda', name : 'MarvinFakeRoleNewName-gn7jizndqm', description : 'Fake role description created after update', ispublic : True}
2026-10-27 14:51:32,559 - DEBUG - Payload: {'id': '8cb60005-a2e6-4c5e-8922-5992a5b8abda', 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'trUoY0ReU9lzuHG4VKdlHnDuRSQ='}
2026-10-27 14:51:32,559 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-27 14:51:32,579 - DEBUG - Response : [{type : 'Admin', isdefault : False, state : 'enabled', id : '8cb60005-a2e6-4c5e-8922-5992a5b8abda', name : 'MarvinFakeRoleNewName-gn7jizndqm', description : 'Fake role description created after update', ispublic : True}]
2026-10-27 14:51:32,580 - DEBUG - Payload: {'id': 'e7240cf3-45a9-4bf9-9c5e-b4eea396eb51', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'x2xLoIp2f9Kjpoo/KrfIsn2fYbE='}
2026-10-27 14:51:32,580 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:32,619 - DEBUG - === Jobid: 28e7ecc4-6e32-43c2-90c0-b34d9084b59d Started ===
2026-10-27 14:51:32,620 - DEBUG - Payload: {'jobid': '28e7ecc4-6e32-43c2-90c0-b34d9084b59d', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'LgENzDYrNsSPaQtP70irokpnBC4='}
2026-10-27 14:51:32,620 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:32,650 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'e7240cf3-45a9-4bf9-9c5e-b4eea396eb51', created : '2026-10-27T14:51:33+0000', completed : '2026-10-27T14:51:33+0000', jobid : '28e7ecc4-6e32-43c2-90c0-b34d9084b59d', jobstatus : 1}
2026-10-27 14:51:32,650 - DEBUG - ===Jobid:28e7ecc4-6e32-43c2-90c0-b34d9084b59d ; StartTime:Tue Oct 27 14:51:32 2026 ; EndTime:Tue Oct 27 14:51:32 2026 ; TotalTime:0===
2026-10-27 14:51:32,650 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'e7240cf3-45a9-4bf9-9c5e-b4eea396eb51', created : '2026-10-27T14:51:33+0000', completed : '2026-10-27T14:51:33+0000', jobid : '28e7ecc4-6e32-43c2-90c0-b34d9084b59d', jobstatus : 1}
2026-10-27 14:51:32,651 - DEBUG - Payload: {'id': 'a658da59-817b-4e21-807b-f8d6af16ae67', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'sXRJ8jD1dZNQLR4xdyJOTtCvL4A='}
2026-10-27 14:51:32,651 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:32,680 - DEBUG - Response : {success : True}
2026-10-27 14:51:32,680 - DEBUG - Payload: {'id': '8cb60005-a2e6-4c5e-8922-5992a5b8abda', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'6vuvJ1ujfJF1jKmXpPBj/nKEoi8='}
2026-10-27 14:51:32,681 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:32,712 - DEBUG - Response : {success : True}
2026-10-27 14:51:32,713 - DEBUG - TestCaseName: test_role_lifecycle_update; Time Taken: 2 Seconds; StartTime: Tue Oct 27 14:51:30 2026; EndTime: Tue Oct 27 14:51:32 2026; Result: SUCCESS
2026-10-27 14:51:32,713 - DEBUG - ::::::::::::STARTED : TC: test_role_lifecycle_update_role_inuse :::::::::::
2026-10-27 14:51:32,713 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:32,713 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:32,746 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:32,747 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role f826mb18dv', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'sFryYEnbSAw/a1vhzZqZkNsmXw4='}
2026-10-27 14:51:32,747 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:32,778 - DEBUG - Response : {type : 'User', state : 'enabled', id : '8c55760b-efa5-49d9-843d-0a0078c7f0e0', name : 'MarvinFake Role f826mb18dv', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:32,779 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '8c55760b-efa5-49d9-843d-0a0078c7f0e0', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'5ih8LzQeoyt0bCZBJ1sel0tWFm4='}
2026-10-27 14:51:32,779 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:32,807 - DEBUG - Response : {id : 'ce5e6c2f-c1ef-42ba-bf73-931362099eb6', roleid : '8c55760b-efa5-49d9-843d-0a0078c7f0e0', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:32,808 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '8c55760b-efa5-49d9-843d-0a0078c7f0e0', 'username': 'rolete-TestDynamicRoles-test_role_lifecycle_update_role_inuse-E8XRCS', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Fp0UEiZqpNB8PurGdk+mS9bXaUk='}
2026-10-27 14:51:32,808 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:33,602 - DEBUG - Response : {id : 'a080a18b-350b-4853-95b3-80bbebb3f4c7', name : 'rolete-TestDynamicRoles-test_role_lifecycle_update_role_inuse-E8XRCS', accounttype : 0, roleid : '8c55760b-efa5-49d9-843d-0a0078c7f0e0', roletype : 'User', rolename : 'MarvinFake Role f826mb18dv', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:33+0000', user : [{id : '577e4fdb-3364-4736-a264-3a8b1f421cdf', username : 'rolete-TestDynamicRoles-test_role_lifecycle_update_role_inuse-E8XRCS', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:34+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_role_lifecycle_update_role_inuse-E8XRCS', accounttype : 0, usersource : 'native', roleid : '8c55760b-efa5-49d9-843d-0a0078c7f0e0', roletype : 'User', rolename : 'MarvinFake Role f826mb18dv', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : 'a080a18b-350b-4853-95b3-80bbebb3f4c7', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:33,603 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:33,603 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:33,645 - 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-27 14:51:33,646 - DEBUG - Payload: {'id': '8c55760b-efa5-49d9-843d-0a0078c7f0e0', 'name': 'MarvinFakeRoleNewName-6k9kw99pn8', 'type': 'Admin', 'command': 'updateRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'xwTxXF+0a3JqxTCTP62LDALBvNE='}
2026-10-27 14:51:33,646 - DEBUG - ========Sending GET Cmd : updateRole=======
2026-10-27 14:51:33,670 - 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-27 14:51:33,671 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.updateRole.updateRoleCmd object at 0x7f8d657d6640> 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-27 14:51:33,671 - DEBUG - Payload: {'id': '8c55760b-efa5-49d9-843d-0a0078c7f0e0', 'name': 'MarvinFakeRoleNewName-6k9kw99pn8', 'command': 'updateRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Np+ffZ398njtKsXWsQSNqsJ6mb4='}
2026-10-27 14:51:33,671 - DEBUG - ========Sending GET Cmd : updateRole=======
2026-10-27 14:51:33,694 - DEBUG - Response : {type : 'User', state : 'enabled', id : '8c55760b-efa5-49d9-843d-0a0078c7f0e0', name : 'MarvinFakeRoleNewName-6k9kw99pn8', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:33,695 - DEBUG - Payload: {'id': '8c55760b-efa5-49d9-843d-0a0078c7f0e0', 'command': 'listRoles', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'6ibczs1n2EXhALgn3IdGMtHqHwA='}
2026-10-27 14:51:33,695 - DEBUG - ========Sending GET Cmd : listRoles=======
2026-10-27 14:51:33,709 - DEBUG - Response : [{type : 'User', isdefault : False, state : 'enabled', id : '8c55760b-efa5-49d9-843d-0a0078c7f0e0', name : 'MarvinFakeRoleNewName-6k9kw99pn8', description : 'Fake Role created by Marvin test', ispublic : True}]
2026-10-27 14:51:33,709 - DEBUG - Payload: {'id': 'a080a18b-350b-4853-95b3-80bbebb3f4c7', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'xGrOsm6dOyY6qXw+nPjz1+kUqZk='}
2026-10-27 14:51:33,709 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:33,734 - DEBUG - === Jobid: 11ee7535-3cca-4e44-afcc-185fb5339824 Started ===
2026-10-27 14:51:33,734 - DEBUG - Payload: {'jobid': '11ee7535-3cca-4e44-afcc-185fb5339824', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ievVviZxV3lc21XlE/M2S0PjHD0='}
2026-10-27 14:51:33,734 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:33,763 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'a080a18b-350b-4853-95b3-80bbebb3f4c7', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:34+0000', jobid : '11ee7535-3cca-4e44-afcc-185fb5339824', jobstatus : 0}
2026-10-27 14:51:34,765 - DEBUG - === JobId:11ee7535-3cca-4e44-afcc-185fb5339824 is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:34,765 - DEBUG - Payload: {'jobid': '11ee7535-3cca-4e44-afcc-185fb5339824', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ievVviZxV3lc21XlE/M2S0PjHD0='}
2026-10-27 14:51:34,765 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:34,787 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'a080a18b-350b-4853-95b3-80bbebb3f4c7', created : '2026-10-27T14:51:34+0000', completed : '2026-10-27T14:51:34+0000', jobid : '11ee7535-3cca-4e44-afcc-185fb5339824', jobstatus : 1}
2026-10-27 14:51:34,788 - DEBUG - ===Jobid:11ee7535-3cca-4e44-afcc-185fb5339824 ; StartTime:Tue Oct 27 14:51:33 2026 ; EndTime:Tue Oct 27 14:51:34 2026 ; TotalTime:-1===
2026-10-27 14:51:34,788 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'a080a18b-350b-4853-95b3-80bbebb3f4c7', created : '2026-10-27T14:51:34+0000', completed : '2026-10-27T14:51:34+0000', jobid : '11ee7535-3cca-4e44-afcc-185fb5339824', jobstatus : 1}
2026-10-27 14:51:34,789 - DEBUG - Payload: {'id': 'ce5e6c2f-c1ef-42ba-bf73-931362099eb6', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'vnVjzqNQtxb2nwNzcPSlz1sKM/4='}
2026-10-27 14:51:34,789 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:34,827 - DEBUG - Response : {success : True}
2026-10-27 14:51:34,828 - DEBUG - Payload: {'id': '8c55760b-efa5-49d9-843d-0a0078c7f0e0', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'aiLQ4ykMzQnG9RQWRenpAWG81Kw='}
2026-10-27 14:51:34,828 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:34,896 - DEBUG - Response : {success : True}
2026-10-27 14:51:34,896 - DEBUG - TestCaseName: test_role_lifecycle_update_role_inuse; Time Taken: 2 Seconds; StartTime: Tue Oct 27 14:51:32 2026; EndTime: Tue Oct 27 14:51:34 2026; Result: SUCCESS
2026-10-27 14:51:34,896 - DEBUG - ::::::::::::STARTED : TC: test_rolepermission_lifecycle_concurrent_updates :::::::::::
2026-10-27 14:51:34,897 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:34,897 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:34,927 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:34,928 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role pjuzlflf7d', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'2RPn3zfbKvMjLp008n9Clz6Va1g='}
2026-10-27 14:51:34,928 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:34,961 - DEBUG - Response : {type : 'User', state : 'enabled', id : '7d32345d-ef32-4232-b7d9-f2e7e432f0be', name : 'MarvinFake Role pjuzlflf7d', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:34,962 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '7d32345d-ef32-4232-b7d9-f2e7e432f0be', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'34NnQPC1yrehLOAIU0C5BiaiPMI='}
2026-10-27 14:51:34,962 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:34,994 - DEBUG - Response : {id : '65cabe32-d8f0-4154-a6a9-d0f225f5d726', roleid : '7d32345d-ef32-4232-b7d9-f2e7e432f0be', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:34,995 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '7d32345d-ef32-4232-b7d9-f2e7e432f0be', 'username': 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_concurrent_updates-2SUR2F', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'tMxRggSlC5GBNfmS65fNvwog3lI='}
2026-10-27 14:51:34,995 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:35,794 - DEBUG - Response : {id : 'f491a9db-5ef6-48b6-b187-bb416335b9c5', name : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_concurrent_updates-2SUR2F', accounttype : 0, roleid : '7d32345d-ef32-4232-b7d9-f2e7e432f0be', roletype : 'User', rolename : 'MarvinFake Role pjuzlflf7d', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:35+0000', user : [{id : '8e8d22bd-64fa-4ab0-a491-c3da29a92766', username : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_concurrent_updates-2SUR2F', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:36+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_concurrent_updates-2SUR2F', accounttype : 0, usersource : 'native', roleid : '7d32345d-ef32-4232-b7d9-f2e7e432f0be', roletype : 'User', rolename : 'MarvinFake Role pjuzlflf7d', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : 'f491a9db-5ef6-48b6-b187-bb416335b9c5', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:35,794 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:35,795 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:35,815 - 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-27 14:51:35,816 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '7d32345d-ef32-4232-b7d9-f2e7e432f0be', 'rule': 'list*', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Ktdi9jakabO5fxzXF/YIRmL/3eA='}
2026-10-27 14:51:35,816 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:35,843 - DEBUG - Response : {id : 'd00eb493-923b-4288-9b4d-b9ff647c4f47', roleid : '7d32345d-ef32-4232-b7d9-f2e7e432f0be', rule : 'list*', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:35,844 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '7d32345d-ef32-4232-b7d9-f2e7e432f0be', 'rule': '*Vol*', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'16AVX/7BNa64SKNtgc6vvlNZoWY='}
2026-10-27 14:51:35,844 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:35,881 - DEBUG - Response : {id : '487551c1-07cf-48ab-a04f-cf583921d235', roleid : '7d32345d-ef32-4232-b7d9-f2e7e432f0be', rule : '*Vol*', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:35,881 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '7d32345d-ef32-4232-b7d9-f2e7e432f0be', 'rule': 'listCapabilities', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'0XTvXUnC1kXHT6JkkhUUdYhg5V8='}
2026-10-27 14:51:35,881 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:35,914 - DEBUG - Response : {id : '6dd77a6f-16e1-41c6-bc27-57b88222ed06', roleid : '7d32345d-ef32-4232-b7d9-f2e7e432f0be', rule : 'listCapabilities', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:35,915 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '7d32345d-ef32-4232-b7d9-f2e7e432f0be', 'rule': 'someRule*', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'/Gph5zIiRBVGDsLBVWcShI2gilU='}
2026-10-27 14:51:35,915 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:35,977 - DEBUG - Response : {id : 'fa5d5999-b89e-4723-82c4-9cacf058b9a4', roleid : '7d32345d-ef32-4232-b7d9-f2e7e432f0be', rule : 'someRule*', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:35,978 - DEBUG - Payload: {'roleid': '7d32345d-ef32-4232-b7d9-f2e7e432f0be', 'ruleorder': '65cabe32-d8f0-4154-a6a9-d0f225f5d726,6dd77a6f-16e1-41c6-bc27-57b88222ed06,d00eb493-923b-4288-9b4d-b9ff647c4f47,487551c1-07cf-48ab-a04f-cf583921d235', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'd9eRByTtCX3O8L3+GDUxIO55rHM='}
2026-10-27 14:51:35,978 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-27 14:51:36,039 - 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-27 14:51:36,040 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.updateRolePermission.updateRolePermissionCmd object at 0x7f8d657d6460> 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-27 14:51:36,040 - DEBUG - Payload: {'id': 'f491a9db-5ef6-48b6-b187-bb416335b9c5', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'yrO/CDyjGiK4vszy/J+lLM/f/TM='}
2026-10-27 14:51:36,040 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:36,076 - DEBUG - === Jobid: 92037747-d44c-4ddc-89a1-2f6b4d43c4ad Started ===
2026-10-27 14:51:36,077 - DEBUG - Payload: {'jobid': '92037747-d44c-4ddc-89a1-2f6b4d43c4ad', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'9Vc+Y75VtluARsHSzGh5iOUQhVU='}
2026-10-27 14:51:36,077 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:36,102 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'f491a9db-5ef6-48b6-b187-bb416335b9c5', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:36+0000', jobid : '92037747-d44c-4ddc-89a1-2f6b4d43c4ad', jobstatus : 0}
2026-10-27 14:51:37,104 - DEBUG - === JobId:92037747-d44c-4ddc-89a1-2f6b4d43c4ad is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:37,104 - DEBUG - Payload: {'jobid': '92037747-d44c-4ddc-89a1-2f6b4d43c4ad', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'9Vc+Y75VtluARsHSzGh5iOUQhVU='}
2026-10-27 14:51:37,104 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:37,130 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'f491a9db-5ef6-48b6-b187-bb416335b9c5', created : '2026-10-27T14:51:36+0000', completed : '2026-10-27T14:51:36+0000', jobid : '92037747-d44c-4ddc-89a1-2f6b4d43c4ad', jobstatus : 1}
2026-10-27 14:51:37,131 - DEBUG - ===Jobid:92037747-d44c-4ddc-89a1-2f6b4d43c4ad ; StartTime:Tue Oct 27 14:51:36 2026 ; EndTime:Tue Oct 27 14:51:37 2026 ; TotalTime:-1===
2026-10-27 14:51:37,131 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'f491a9db-5ef6-48b6-b187-bb416335b9c5', created : '2026-10-27T14:51:36+0000', completed : '2026-10-27T14:51:36+0000', jobid : '92037747-d44c-4ddc-89a1-2f6b4d43c4ad', jobstatus : 1}
2026-10-27 14:51:37,131 - DEBUG - Payload: {'id': '65cabe32-d8f0-4154-a6a9-d0f225f5d726', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'upuOqsx/liEyQkos6fcyK98qVxQ='}
2026-10-27 14:51:37,131 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:37,161 - DEBUG - Response : {success : True}
2026-10-27 14:51:37,162 - DEBUG - Payload: {'id': '7d32345d-ef32-4232-b7d9-f2e7e432f0be', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'0cXrEJjb9hLogvblhFajji/fS+s='}
2026-10-27 14:51:37,162 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:37,218 - DEBUG - Response : {success : True}
2026-10-27 14:51:37,219 - DEBUG - Payload: {'id': 'd00eb493-923b-4288-9b4d-b9ff647c4f47', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'eHOMbb+yblpBDw115DY+r91ztCY='}
2026-10-27 14:51:37,219 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:37,235 - 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=d00eb493-923b-4288-9b4d-b9ff647c4f47 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=d00eb493-923b-4288-9b4d-b9ff647c4f47 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-27 14:51:37,235 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRolePermission.deleteRolePermissionCmd object at 0x7f8d657d7d00> 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=d00eb493-923b-4288-9b4d-b9ff647c4f47 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=d00eb493-923b-4288-9b4d-b9ff647c4f47 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-27 14:51:37,235 - 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=d00eb493-923b-4288-9b4d-b9ff647c4f47 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-27 14:51:37,236 - DEBUG - TestCaseName: test_rolepermission_lifecycle_concurrent_updates; Time Taken: 2 Seconds; StartTime: Tue Oct 27 14:51:34 2026; EndTime: Tue Oct 27 14:51:37 2026; Result: SUCCESS
2026-10-27 14:51:37,236 - DEBUG - ::::::::::::STARTED : TC: test_rolepermission_lifecycle_create :::::::::::
2026-10-27 14:51:37,236 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:37,236 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:37,260 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:37,261 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role nrrr9gem2b', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'83yJXrOnvTYslw99UBe+oGH26qk='}
2026-10-27 14:51:37,261 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:37,286 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'f2081d23-b865-41c0-9456-294093df441a', name : 'MarvinFake Role nrrr9gem2b', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:37,287 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'f2081d23-b865-41c0-9456-294093df441a', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'c0tbb1jNz3B7kU3QqKLj+s1XVjA='}
2026-10-27 14:51:37,287 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:37,312 - DEBUG - Response : {id : '6db1efa2-d9b4-4ef8-867a-c969a2c937f5', roleid : 'f2081d23-b865-41c0-9456-294093df441a', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:37,313 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': 'f2081d23-b865-41c0-9456-294093df441a', 'username': 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_create-IMZM3G', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ZpGIG84o/WOtL+3otJRf0JoNMIQ='}
2026-10-27 14:51:37,313 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:38,132 - DEBUG - Response : {id : '518c67e7-a768-4157-8a61-aad1d43dc014', name : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_create-IMZM3G', accounttype : 0, roleid : 'f2081d23-b865-41c0-9456-294093df441a', roletype : 'User', rolename : 'MarvinFake Role nrrr9gem2b', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:38+0000', user : [{id : 'e188f818-de26-4ce2-afec-176b15228f5d', username : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_create-IMZM3G', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:38+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_create-IMZM3G', accounttype : 0, usersource : 'native', roleid : 'f2081d23-b865-41c0-9456-294093df441a', roletype : 'User', rolename : 'MarvinFake Role nrrr9gem2b', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : '518c67e7-a768-4157-8a61-aad1d43dc014', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:38,132 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:38,132 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:38,149 - 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-27 14:51:38,150 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'f2081d23-b865-41c0-9456-294093df441a', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'c0tbb1jNz3B7kU3QqKLj+s1XVjA='}
2026-10-27 14:51:38,150 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:38,174 - 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 nrrr9gem2b\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 nrrr9gem2b
2026-10-27 14:51:38,174 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.createRolePermission.createRolePermissionCmd object at 0x7f8d657d67f0> 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 nrrr9gem2b\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 nrrr9gem2b
2026-10-27 14:51:38,174 - DEBUG - Payload: {'roleid': 'f2081d23-b865-41c0-9456-294093df441a', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'MLrMIVOTMV0y0fM3pGPrtq+hhCc='}
2026-10-27 14:51:38,174 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:38,192 - DEBUG - Response : [{id : '6db1efa2-d9b4-4ef8-867a-c969a2c937f5', roleid : 'f2081d23-b865-41c0-9456-294093df441a', rolename : 'MarvinFake Role nrrr9gem2b', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-27 14:51:38,193 - DEBUG - Payload: {'id': '518c67e7-a768-4157-8a61-aad1d43dc014', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'6n8qKI7/m1ara1/Df20h4uNq5Oo='}
2026-10-27 14:51:38,194 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:38,224 - DEBUG - === Jobid: ef9efd64-8e30-4426-93bd-4edc9fe2b439 Started ===
2026-10-27 14:51:38,224 - DEBUG - Payload: {'jobid': 'ef9efd64-8e30-4426-93bd-4edc9fe2b439', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Nvj6LYWRW5czJ5/HdvLig47Id8s='}
2026-10-27 14:51:38,225 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:38,256 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '518c67e7-a768-4157-8a61-aad1d43dc014', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:38+0000', jobid : 'ef9efd64-8e30-4426-93bd-4edc9fe2b439', jobstatus : 0}
2026-10-27 14:51:39,258 - DEBUG - === JobId:ef9efd64-8e30-4426-93bd-4edc9fe2b439 is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:39,258 - DEBUG - Payload: {'jobid': 'ef9efd64-8e30-4426-93bd-4edc9fe2b439', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Nvj6LYWRW5czJ5/HdvLig47Id8s='}
2026-10-27 14:51:39,258 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:39,288 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '518c67e7-a768-4157-8a61-aad1d43dc014', created : '2026-10-27T14:51:38+0000', completed : '2026-10-27T14:51:38+0000', jobid : 'ef9efd64-8e30-4426-93bd-4edc9fe2b439', jobstatus : 1}
2026-10-27 14:51:39,289 - DEBUG - ===Jobid:ef9efd64-8e30-4426-93bd-4edc9fe2b439 ; StartTime:Tue Oct 27 14:51:38 2026 ; EndTime:Tue Oct 27 14:51:39 2026 ; TotalTime:-1===
2026-10-27 14:51:39,289 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '518c67e7-a768-4157-8a61-aad1d43dc014', created : '2026-10-27T14:51:38+0000', completed : '2026-10-27T14:51:38+0000', jobid : 'ef9efd64-8e30-4426-93bd-4edc9fe2b439', jobstatus : 1}
2026-10-27 14:51:39,289 - DEBUG - Payload: {'id': '6db1efa2-d9b4-4ef8-867a-c969a2c937f5', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AgwFUYmHm0RFXbzmoczDZlKm0Hw='}
2026-10-27 14:51:39,290 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:39,318 - DEBUG - Response : {success : True}
2026-10-27 14:51:39,319 - DEBUG - Payload: {'id': 'f2081d23-b865-41c0-9456-294093df441a', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'WxxAEryuE9BOoLcTPuSOuZ48clc='}
2026-10-27 14:51:39,319 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:39,346 - DEBUG - Response : {success : True}
2026-10-27 14:51:39,346 - DEBUG - TestCaseName: test_rolepermission_lifecycle_create; Time Taken: 2 Seconds; StartTime: Tue Oct 27 14:51:37 2026; EndTime: Tue Oct 27 14:51:39 2026; Result: SUCCESS
2026-10-27 14:51:39,347 - DEBUG - ::::::::::::STARTED : TC: test_rolepermission_lifecycle_delete :::::::::::
2026-10-27 14:51:39,347 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:39,347 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:39,373 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:39,373 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role zwxnqfwa2q', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'g9RzZu+cE9rnIHiuF75XbIV4Ayo='}
2026-10-27 14:51:39,374 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:39,415 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'c8dfe49d-1786-462a-a726-5757ac91f191', name : 'MarvinFake Role zwxnqfwa2q', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:39,416 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'c8dfe49d-1786-462a-a726-5757ac91f191', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'FLEGFpPKD/1vw+Xc/W+A13vBY70='}
2026-10-27 14:51:39,416 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:39,496 - DEBUG - Response : {id : '1605477b-0342-411f-a727-0306aa3b9957', roleid : 'c8dfe49d-1786-462a-a726-5757ac91f191', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:39,496 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': 'c8dfe49d-1786-462a-a726-5757ac91f191', 'username': 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_delete-CYE5VE', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ssgAHdXmdScOi6UndamQVY7pRPQ='}
2026-10-27 14:51:39,496 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:40,389 - DEBUG - Response : {id : 'ace39f5c-e1f4-46e9-bd90-872301a83526', name : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_delete-CYE5VE', accounttype : 0, roleid : 'c8dfe49d-1786-462a-a726-5757ac91f191', roletype : 'User', rolename : 'MarvinFake Role zwxnqfwa2q', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:40+0000', user : [{id : 'e8e4de2d-44ed-4cce-bb08-d06bd4e13c54', username : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_delete-CYE5VE', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:40+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_delete-CYE5VE', accounttype : 0, usersource : 'native', roleid : 'c8dfe49d-1786-462a-a726-5757ac91f191', roletype : 'User', rolename : 'MarvinFake Role zwxnqfwa2q', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : 'ace39f5c-e1f4-46e9-bd90-872301a83526', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:40,390 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:40,391 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:40,416 - 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-27 14:51:40,416 - DEBUG - Payload: {'id': '1605477b-0342-411f-a727-0306aa3b9957', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'DImE4A48bz8cmv2BCt0ePGY0OUY='}
2026-10-27 14:51:40,416 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:40,442 - DEBUG - Response : {success : True}
2026-10-27 14:51:40,443 - DEBUG - Payload: {'roleid': 'c8dfe49d-1786-462a-a726-5757ac91f191', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ESMu7W/NQNd5SY3Pl3c0SD6n0uE='}
2026-10-27 14:51:40,443 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:40,462 - DEBUG - Response : None
2026-10-27 14:51:40,463 - DEBUG - Payload: {'id': 'ace39f5c-e1f4-46e9-bd90-872301a83526', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'DEgVE7Ys8kmM4+PkiSzRT7d0GzU='}
2026-10-27 14:51:40,463 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:40,497 - DEBUG - === Jobid: 037e6f31-e435-49c2-a3be-33a894e2bc92 Started ===
2026-10-27 14:51:40,498 - DEBUG - Payload: {'jobid': '037e6f31-e435-49c2-a3be-33a894e2bc92', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'xG3thR0KZ5jadDmsLdeIeJ6HSso='}
2026-10-27 14:51:40,498 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:40,524 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'ace39f5c-e1f4-46e9-bd90-872301a83526', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:40+0000', jobid : '037e6f31-e435-49c2-a3be-33a894e2bc92', jobstatus : 0}
2026-10-27 14:51:41,525 - DEBUG - === JobId:037e6f31-e435-49c2-a3be-33a894e2bc92 is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:41,526 - DEBUG - Payload: {'jobid': '037e6f31-e435-49c2-a3be-33a894e2bc92', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'xG3thR0KZ5jadDmsLdeIeJ6HSso='}
2026-10-27 14:51:41,526 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:41,553 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'ace39f5c-e1f4-46e9-bd90-872301a83526', created : '2026-10-27T14:51:40+0000', completed : '2026-10-27T14:51:41+0000', jobid : '037e6f31-e435-49c2-a3be-33a894e2bc92', jobstatus : 1}
2026-10-27 14:51:41,553 - DEBUG - ===Jobid:037e6f31-e435-49c2-a3be-33a894e2bc92 ; StartTime:Tue Oct 27 14:51:40 2026 ; EndTime:Tue Oct 27 14:51:41 2026 ; TotalTime:-1===
2026-10-27 14:51:41,554 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'ace39f5c-e1f4-46e9-bd90-872301a83526', created : '2026-10-27T14:51:40+0000', completed : '2026-10-27T14:51:41+0000', jobid : '037e6f31-e435-49c2-a3be-33a894e2bc92', jobstatus : 1}
2026-10-27 14:51:41,554 - DEBUG - Payload: {'id': 'c8dfe49d-1786-462a-a726-5757ac91f191', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'OsKNRZpIKHHcdLntzNMYXTnlN50='}
2026-10-27 14:51:41,554 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:41,580 - DEBUG - Response : {success : True}
2026-10-27 14:51:41,581 - DEBUG - TestCaseName: test_rolepermission_lifecycle_delete; Time Taken: 2 Seconds; StartTime: Tue Oct 27 14:51:39 2026; EndTime: Tue Oct 27 14:51:41 2026; Result: SUCCESS
2026-10-27 14:51:41,581 - DEBUG - ::::::::::::STARTED : TC: test_rolepermission_lifecycle_list :::::::::::
2026-10-27 14:51:41,582 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:41,582 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:41,604 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:41,604 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role yzwl5oigka', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'9uc2biX67/xDhLVvhViswgdaLEk='}
2026-10-27 14:51:41,604 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:41,625 - DEBUG - Response : {type : 'User', state : 'enabled', id : '8e8ca2ac-5870-4e71-8ae5-454b06556224', name : 'MarvinFake Role yzwl5oigka', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:41,626 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '8e8ca2ac-5870-4e71-8ae5-454b06556224', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'D88PwVTmvVsSLwSngWusyaaRi+A='}
2026-10-27 14:51:41,626 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:41,650 - DEBUG - Response : {id : 'f3c42f47-99af-4a0c-9b6c-546bb09a883e', roleid : '8e8ca2ac-5870-4e71-8ae5-454b06556224', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:41,651 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '8e8ca2ac-5870-4e71-8ae5-454b06556224', 'username': 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_list-TDZ389', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'BFbyJBqwIFzZAo9AqfdCz+XG2Yk='}
2026-10-27 14:51:41,651 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:42,428 - DEBUG - Response : {id : '7682db45-34a0-4b86-9ebc-a6fe9acaf649', name : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_list-TDZ389', accounttype : 0, roleid : '8e8ca2ac-5870-4e71-8ae5-454b06556224', roletype : 'User', rolename : 'MarvinFake Role yzwl5oigka', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:42+0000', user : [{id : '437a60e8-6460-40ae-841f-6c5a1a3bf61c', username : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_list-TDZ389', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:42+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_list-TDZ389', accounttype : 0, usersource : 'native', roleid : '8e8ca2ac-5870-4e71-8ae5-454b06556224', roletype : 'User', rolename : 'MarvinFake Role yzwl5oigka', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : '7682db45-34a0-4b86-9ebc-a6fe9acaf649', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:42,429 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:42,429 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:42,450 - 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-27 14:51:42,451 - DEBUG - Payload: {'roleid': 1, 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'iqrA2f+nNAtV4fjpw78YniIYNvk='}
2026-10-27 14:51:42,451 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:42,465 - DEBUG - Response : [{id : '8848923f-d1fe-11f1-81aa-1e0044000301', roleid : '87d83eed-d1fe-11f1-81aa-1e0044000301', rolename : 'Root Admin', rule : '*', permission : 'allow'}]
2026-10-27 14:51:42,466 - DEBUG - Payload: {'roleid': 2, 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'hnBhND1Q8Tdz6C92LpIHbL2TG6g='}
2026-10-27 14:51:42,466 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:42,492 - DEBUG - Response : [{id : '8848b1ca-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'activateProject', permission : 'allow'}, {id : '93e7b96e-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'addAnnotation', permission : 'allow'}, {id : '9b3f6ece-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'assignVolume', permission : 'allow'}, {id : '93e6fce1-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listAnnotations', permission : 'allow'}, {id : '93e7ecd0-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'removeAnnotation', permission : 'allow'}, {id : '8848c029-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'addAccountToProject', permission : 'allow'}, {id : '8848cabe-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'addHost', permission : 'allow'}, {id : '8848d11c-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'addIpToNic', permission : 'allow'}, {id : '8848d89c-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'addLdapConfiguration', permission : 'allow'}, {id : '8848e337-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'addNicToVirtualMachine', permission : 'allow'}, {id : '8848eee9-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'addVpnUser', permission : 'allow'}, {id : '8848f65d-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'archiveEvents', permission : 'allow'}, {id : '8848fc2e-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'assignCertToLoadBalancer', permission : 'allow'}, {id : '884908aa-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'assignToGlobalLoadBalancerRule', permission : 'allow'}, {id : '88491587-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'assignToLoadBalancerRule', permission : 'allow'}, {id : '88492117-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'assignVirtualMachine', permission : 'allow'}, {id : '88492a3a-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'associateIpAddress', permission : 'allow'}, {id : '88497646-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'attachIso', permission : 'allow'}, {id : '8849d2fe-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'attachVolume', permission : 'allow'}, {id : '884a2244-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'authorizeSamlSso', permission : 'allow'}, {id : '884a5de2-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'authorizeSecurityGroupEgress', permission : 'allow'}, {id : '884a71be-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'authorizeSecurityGroupIngress', permission : 'allow'}, {id : '884a81fc-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'changeServiceForRouter', permission : 'allow'}, {id : '884a8f1b-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'changeServiceForVirtualMachine', permission : 'allow'}, {id : '884a9ded-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'configureInternalLoadBalancerElement', permission : 'allow'}, {id : '884aa933-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'configureOvsElement', permission : 'allow'}, {id : '884ab322-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'configureVirtualRouterElement', permission : 'allow'}, {id : '884abd9b-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'copyIso', permission : 'allow'}, {id : '884ac7a1-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'copyTemplate', permission : 'allow'}, {id : '884ad163-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createAccount', permission : 'allow'}, {id : '884ada61-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createAffinityGroup', permission : 'allow'}, {id : '884ae3f7-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createAutoScalePolicy', permission : 'allow'}, {id : '884af06f-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createAutoScaleVmGroup', permission : 'allow'}, {id : '884afb77-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createAutoScaleVmProfile', permission : 'allow'}, {id : '884b052d-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createCondition', permission : 'allow'}, {id : '884b0e14-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createDiskOffering', permission : 'allow'}, {id : '884b15a8-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createEgressFirewallRule', permission : 'allow'}, {id : '884b1e22-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createFirewallRule', permission : 'allow'}, {id : '884b307b-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createGlobalLoadBalancerRule', permission : 'allow'}, {id : '884b3d74-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createInstanceGroup', permission : 'allow'}, {id : '884b4b8f-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createInternalLoadBalancerElement', permission : 'allow'}, {id : '884b5751-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createIpForwardingRule', permission : 'allow'}, {id : '884b604c-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createLBHealthCheckPolicy', permission : 'allow'}, {id : '884b68ac-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createLBStickinessPolicy', permission : 'allow'}, {id : '884b707c-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createLoadBalancer', permission : 'allow'}, {id : '884b7704-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createLoadBalancerRule', permission : 'allow'}, {id : '884b89b3-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createNetwork', permission : 'allow'}, {id : '884b915b-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createNetworkACL', permission : 'allow'}, {id : '884b986d-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createNetworkACLList', permission : 'allow'}, {id : '884b9e67-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createOvsElement', permission : 'allow'}, {id : '884baf99-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createPortForwardingRule', permission : 'allow'}, {id : '884bb6d8-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createProject', permission : 'allow'}, {id : '884bbef4-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createRemoteAccessVpn', permission : 'allow'}, {id : '884bc602-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createSSHKeyPair', permission : 'allow'}, {id : '884bce38-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createSecurityGroup', permission : 'allow'}, {id : '884bd62c-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createServiceOffering', permission : 'allow'}, {id : '884bdeda-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createSnapshot', permission : 'allow'}, {id : '884be642-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createSnapshotPolicy', permission : 'allow'}, {id : '884bebbe-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createStaticRoute', permission : 'allow'}, {id : '884bf204-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createTags', permission : 'allow'}, {id : '884bfbbf-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createTemplate', permission : 'allow'}, {id : '884c023e-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createUser', permission : 'allow'}, {id : '884c0ca7-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createVMSnapshot', permission : 'allow'}, {id : '884c1401-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createVPC', permission : 'allow'}, {id : '884c1cbe-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createVirtualRouterElement', permission : 'allow'}, {id : '884c26ed-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createVolume', permission : 'allow'}, {id : '884c3a7e-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createVpnConnection', permission : 'allow'}, {id : '884c431b-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createVpnCustomerGateway', permission : 'allow'}, {id : '884c4b31-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createVpnGateway', permission : 'allow'}, {id : '884c514a-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteAccount', permission : 'allow'}, {id : '884c580f-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteAccountFromProject', permission : 'allow'}, {id : '884c5d64-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteAffinityGroup', permission : 'allow'}, {id : '884c6677-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteAutoScalePolicy', permission : 'allow'}, {id : '884c7115-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteAutoScaleVmGroup', permission : 'allow'}, {id : '884c7b06-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteAutoScaleVmProfile', permission : 'allow'}, {id : '884c8348-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteCondition', permission : 'allow'}, {id : '884c898a-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteDiskOffering', permission : 'allow'}, {id : '884c90e0-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteEgressFirewallRule', permission : 'allow'}, {id : '884c999d-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteEvents', permission : 'allow'}, {id : '884ca124-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteFirewallRule', permission : 'allow'}, {id : '884caa48-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteGlobalLoadBalancerRule', permission : 'allow'}, {id : '884cb30c-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteHost', permission : 'allow'}, {id : '884cc359-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteInstanceGroup', permission : 'allow'}, {id : '884cd1ce-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteIpForwardingRule', permission : 'allow'}, {id : '884cde3a-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteIso', permission : 'allow'}, {id : '884ce875-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteLBHealthCheckPolicy', permission : 'allow'}, {id : '884cf020-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteLBStickinessPolicy', permission : 'allow'}, {id : '884cfa8e-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteLdapConfiguration', permission : 'allow'}, {id : '884d048b-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteLoadBalancer', permission : 'allow'}, {id : '884d0f56-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteLoadBalancerRule', permission : 'allow'}, {id : '884d18fb-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteNetwork', permission : 'allow'}, {id : '884d23ff-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteNetworkACL', permission : 'allow'}, {id : '884d2e07-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteNetworkACLList', permission : 'allow'}, {id : '884d43cb-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deletePortForwardingRule', permission : 'allow'}, {id : '884d5116-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteProject', permission : 'allow'}, {id : '884d5cf4-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteProjectInvitation', permission : 'allow'}, {id : '884d65c9-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteRemoteAccessVpn', permission : 'allow'}, {id : '884d6ec7-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteSSHKeyPair', permission : 'allow'}, {id : '884d77f5-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteSecurityGroup', permission : 'allow'}, {id : '884d84b4-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteServiceOffering', permission : 'allow'}, {id : '8cf323f6-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'moveNetworkAclItem', permission : 'allow'}, {id : '884d8cb7-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteSnapshot', permission : 'allow'}, {id : '884d9561-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteSnapshotPolicies', permission : 'allow'}, {id : '884d9f89-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteSslCert', permission : 'allow'}, {id : '884da9dd-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteStaticRoute', permission : 'allow'}, {id : '884db1d4-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteTags', permission : 'allow'}, {id : '884dbbb0-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteTemplate', permission : 'allow'}, {id : '884dc4f8-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteUser', permission : 'allow'}, {id : '884dcfbb-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteVMSnapshot', permission : 'allow'}, {id : '884ddc86-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteVPC', permission : 'allow'}, {id : '884de754-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteVolume', permission : 'allow'}, {id : '884df2eb-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteVpnConnection', permission : 'allow'}, {id : '884e0133-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteVpnCustomerGateway', permission : 'allow'}, {id : '884e0ff2-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteVpnGateway', permission : 'allow'}, {id : '884e198d-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deployVirtualMachine', permission : 'allow'}, {id : '884e2b6e-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'destroyRouter', permission : 'allow'}, {id : '884e3993-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'destroyVirtualMachine', permission : 'allow'}, {id : '884e4aea-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'detachIso', permission : 'allow'}, {id : '884e5296-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'detachVolume', permission : 'allow'}, {id : '884e589a-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'disableAccount', permission : 'allow'}, {id : '884e642a-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'disableAutoScaleVmGroup', permission : 'allow'}, {id : '884e6d67-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'disableStaticNat', permission : 'allow'}, {id : '884e7317-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'disableUser', permission : 'allow'}, {id : '884e7b57-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'disassociateIpAddress', permission : 'allow'}, {id : '884e99ec-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'enableAccount', permission : 'allow'}, {id : '884ea455-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'enableAutoScaleVmGroup', permission : 'allow'}, {id : '884eae4a-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'enableStaticNat', permission : 'allow'}, {id : '884eba4c-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'enableUser', permission : 'allow'}, {id : '884ec262-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'expungeVirtualMachine', permission : 'allow'}, {id : '884eca98-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'extractIso', permission : 'allow'}, {id : '884ed2b0-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'extractTemplate', permission : 'allow'}, {id : '884edba6-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'extractVolume', permission : 'allow'}, {id : '884ee5fb-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'getApiLimit', permission : 'allow'}, {id : '884eee29-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'getCloudIdentifier', permission : 'allow'}, {id : '884ef4b2-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'getSolidFireAccountId', permission : 'allow'}, {id : '884efc20-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'getSolidFireVolumeAccessGroupId', permission : 'allow'}, {id : '884f05ba-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'getSolidFireVolumeIscsiName', permission : 'allow'}, {id : '884f0c72-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'getSolidFireVolumeSize', permission : 'allow'}, {id : '884f161f-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'getUploadParamsForTemplate', permission : 'allow'}, {id : '884f1d61-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'getUploadParamsForVolume', permission : 'allow'}, {id : '884f277f-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'getVMPassword', permission : 'allow'}, {id : '8850a736-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'getVirtualMachineUserData', permission : 'allow'}, {id : '8850c46a-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'importLdapUsers', permission : 'allow'}, {id : '8850cf01-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'ldapCreateAccount', permission : 'allow'}, {id : '8850d68d-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'linkDomainToLdap', permission : 'allow'}, {id : '8850de19-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listAccounts', permission : 'allow'}, {id : '8850e50a-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listAffinityGroupTypes', permission : 'allow'}, {id : '8850f059-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listAffinityGroups', permission : 'allow'}, {id : '8850f884-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listAlerts', permission : 'allow'}, {id : '8850fea9-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listApis', permission : 'allow'}, {id : '8851046f-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listAsyncJobs', permission : 'allow'}, {id : '8851090c-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listAutoScalePolicies', permission : 'allow'}, {id : '88512558-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listAutoScaleVmGroups', permission : 'allow'}, {id : '88512dc8-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listAutoScaleVmProfiles', permission : 'allow'}, {id : '885132cd-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listCapabilities', permission : 'allow'}, {id : '88513ea1-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listCapacity', permission : 'allow'}, {id : '88514ae7-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listClusters', permission : 'allow'}, {id : '885157d4-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listConditions', permission : 'allow'}, {id : '885164f0-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listCounters', permission : 'allow'}, {id : '88517283-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listDiskOfferings', permission : 'allow'}, {id : '88517ca5-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listDomainChildren', permission : 'allow'}, {id : '885183d7-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listDomains', permission : 'allow'}, {id : '88518b55-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listEgressFirewallRules', permission : 'allow'}, {id : '88519283-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listEventTypes', permission : 'allow'}, {id : '885199de-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listEvents', permission : 'allow'}, {id : '88519fb2-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listFirewallRules', permission : 'allow'}, {id : '8851a7ea-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listGlobalLoadBalancerRules', permission : 'allow'}, {id : '8851ad3f-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listHostTags', permission : 'allow'}, {id : '8851b5e2-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listHosts', permission : 'allow'}, {id : '8851be01-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listHypervisors', permission : 'allow'}, {id : '8851c570-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listInstanceGroups', permission : 'allow'}, {id : '8851cc6b-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listInternalLoadBalancerElements', permission : 'allow'}, {id : '8851d58f-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listIpForwardingRules', permission : 'allow'}, {id : '8851dd97-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listIsoPermissions', permission : 'allow'}, {id : '8851ee1d-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listIsos', permission : 'allow'}, {id : '8851f8b8-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listLBHealthCheckPolicies', permission : 'allow'}, {id : '88520083-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listLBStickinessPolicies', permission : 'allow'}, {id : '88520889-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listLdapConfigurations', permission : 'allow'}, {id : '885214b6-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listLdapUsers', permission : 'allow'}, {id : '88521f49-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listLoadBalancerRuleInstances', permission : 'allow'}, {id : '8852291a-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listLoadBalancerRules', permission : 'allow'}, {id : '88523170-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listLoadBalancers', permission : 'allow'}, {id : '88524021-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listNetworkACLLists', permission : 'allow'}, {id : '88524577-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listNetworkACLs', permission : 'allow'}, {id : '88524b72-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listNetworkOfferings', permission : 'allow'}, {id : '88525374-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listNetworks', permission : 'allow'}, {id : '885259f9-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listNics', permission : 'allow'}, {id : '88525fd6-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listOsCategories', permission : 'allow'}, {id : '88526af0-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listOsTypes', permission : 'allow'}, {id : '885276ac-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listOvsElements', permission : 'allow'}, {id : '88528015-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listPods', permission : 'allow'}, {id : '885290ef-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listPortForwardingRules', permission : 'allow'}, {id : '88529cb1-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listPrivateGateways', permission : 'allow'}, {id : '8852ab99-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listProjectAccounts', permission : 'allow'}, {id : '8852b4f0-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listProjectInvitations', permission : 'allow'}, {id : '8852bad5-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listProjects', permission : 'allow'}, {id : '8852c1bc-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listPublicIpAddresses', permission : 'allow'}, {id : '8852c7da-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listRegions', permission : 'allow'}, {id : '8852cd79-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listRemoteAccessVpns', permission : 'allow'}, {id : '8852d1d4-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listResourceDetails', permission : 'allow'}, {id : '8852d701-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listResourceLimits', permission : 'allow'}, {id : '8852ded6-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listRouters', permission : 'allow'}, {id : '8852e42b-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listSSHKeyPairs', permission : 'allow'}, {id : '8852eabd-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listSamlAuthorization', permission : 'allow'}, {id : '8852f0b7-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listSecurityGroups', permission : 'allow'}, {id : '8852f51c-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listServiceOfferings', permission : 'allow'}, {id : '8852f9e0-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listSnapshotPolicies', permission : 'allow'}, {id : '8852ff09-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listSnapshots', permission : 'allow'}, {id : '88530502-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listSslCerts', permission : 'allow'}, {id : '88530b37-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listStaticRoutes', permission : 'allow'}, {id : '885318a5-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listStoragePools', permission : 'allow'}, {id : '8853209d-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listStorageProviders', permission : 'allow'}, {id : '88543722-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listStorageTags', permission : 'allow'}, {id : '8854492e-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listSystemVms', permission : 'allow'}, {id : '885453f3-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listTags', permission : 'allow'}, {id : '88545b19-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listTemplatePermissions', permission : 'allow'}, {id : '88546554-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listTemplates', permission : 'allow'}, {id : '88546c65-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listUsageRecords', permission : 'allow'}, {id : '88547392-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listUsers', permission : 'allow'}, {id : '88547a4c-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listVMSnapshot', permission : 'allow'}, {id : '885483ea-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listVPCOfferings', permission : 'allow'}, {id : '88548b93-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listVPCs', permission : 'allow'}, {id : '88549563-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listVirtualMachines', permission : 'allow'}, {id : '88549cbe-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listVirtualRouterElements', permission : 'allow'}, {id : '8854a3bf-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listVolumes', permission : 'allow'}, {id : '8854b65f-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listVpnConnections', permission : 'allow'}, {id : '8854bd89-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listVpnCustomerGateways', permission : 'allow'}, {id : '8854c46f-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listVpnGateways', permission : 'allow'}, {id : '8854c957-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listVpnUsers', permission : 'allow'}, {id : '8854ce17-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listZones', permission : 'allow'}, {id : '8854d745-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'lockAccount', permission : 'allow'}, {id : '8854de90-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'lockUser', permission : 'allow'}, {id : '8854f2eb-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'queryAsyncJobResult', permission : 'allow'}, {id : '8854f7bb-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'quotaBalance', permission : 'allow'}, {id : '8854feab-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'quotaIsEnabled', permission : 'allow'}, {id : 'a8622bb9-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'quotaCreditsList', permission : 'allow'}, {id : 'afb4e970-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'quotaResourceStatement', permission : 'allow'}, {id : '88550784-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'quotaStatement', permission : 'allow'}, {id : '88550da5-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'quotaSummary', permission : 'allow'}, {id : '885512d9-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'quotaTariffList', permission : 'allow'}, {id : '88551b9b-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'rebootRouter', permission : 'allow'}, {id : '8855267c-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'rebootVirtualMachine', permission : 'allow'}, {id : '88552eda-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'recoverVirtualMachine', permission : 'allow'}, {id : '885534d6-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'registerIso', permission : 'allow'}, {id : '885539f2-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'registerSSHKeyPair', permission : 'allow'}, {id : '88553e43-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'registerTemplate', permission : 'allow'}, {id : '885543d3-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'registerUserKeys', permission : 'allow'}, {id : '885549a3-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'removeCertFromLoadBalancer', permission : 'allow'}, {id : '88554f6d-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'removeFromGlobalLoadBalancerRule', permission : 'allow'}, {id : '885554be-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'removeFromLoadBalancerRule', permission : 'allow'}, {id : '88555917-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'removeIpFromNic', permission : 'allow'}, {id : '88555eaf-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'removeNicFromVirtualMachine', permission : 'allow'}, {id : '88556314-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'removeVpnUser', permission : 'allow'}, {id : '88556973-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'replaceNetworkACLList', permission : 'allow'}, {id : '885574a7-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'resetPasswordForVirtualMachine', permission : 'allow'}, {id : '88557d3c-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'resetSSHKeyForVirtualMachine', permission : 'allow'}, {id : '88558408-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'resetVpnConnection', permission : 'allow'}, {id : '885589e0-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'resizeVolume', permission : 'allow'}, {id : '88559006-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'restartNetwork', permission : 'allow'}, {id : '88559968-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'restartVPC', permission : 'allow'}, {id : '8855a0b0-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'restoreVirtualMachine', permission : 'allow'}, {id : '8855a67b-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'revertSnapshot', permission : 'allow'}, {id : '8855acf4-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'revertToVMSnapshot', permission : 'allow'}, {id : '8855b2fe-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'revokeSecurityGroupEgress', permission : 'allow'}, {id : '8855b893-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'revokeSecurityGroupIngress', permission : 'allow'}, {id : '8855bf1b-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'scaleVirtualMachine', permission : 'allow'}, {id : '8855c6fc-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'startRouter', permission : 'allow'}, {id : '8855cf2c-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'startVirtualMachine', permission : 'allow'}, {id : '8855d5f4-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'stopRouter', permission : 'allow'}, {id : '8855dbf7-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'stopVirtualMachine', permission : 'allow'}, {id : '8855e1bc-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'suspendProject', permission : 'allow'}, {id : '8855e798-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateAccount', permission : 'allow'}, {id : '8855ef79-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateAutoScalePolicy', permission : 'allow'}, {id : '8855f5b3-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateAutoScaleVmGroup', permission : 'allow'}, {id : '8855fb88-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateAutoScaleVmProfile', permission : 'allow'}, {id : '8856018b-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateDefaultNicForVirtualMachine', permission : 'allow'}, {id : '885607c7-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateDiskOffering', permission : 'allow'}, {id : '88560d23-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateEgressFirewallRule', permission : 'allow'}, {id : '8856114c-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateFirewallRule', permission : 'allow'}, {id : '885616c9-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateGlobalLoadBalancerRule', permission : 'allow'}, {id : '88562036-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateInstanceGroup', permission : 'allow'}, {id : '8856261e-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateIpAddress', permission : 'allow'}, {id : '88562cad-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateIso', permission : 'allow'}, {id : '8856337b-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateIsoPermissions', permission : 'allow'}, {id : '88563878-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateLBHealthCheckPolicy', permission : 'allow'}, {id : '88563cc1-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateLBStickinessPolicy', permission : 'allow'}, {id : '885644ad-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateLoadBalancer', permission : 'allow'}, {id : '88564c62-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateLoadBalancerRule', permission : 'allow'}, {id : '88565107-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateNetwork', permission : 'allow'}, {id : '88565527-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateNetworkACLItem', permission : 'allow'}, {id : '885659ef-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateNetworkACLList', permission : 'allow'}, {id : '88566190-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updatePortForwardingRule', permission : 'allow'}, {id : '88566828-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateProject', permission : 'allow'}, {id : '88566ebd-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateProjectInvitation', permission : 'allow'}, {id : '88567577-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateRemoteAccessVpn', permission : 'allow'}, {id : '88567a7f-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateResourceCount', permission : 'allow'}, {id : '8856804e-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateResourceLimit', permission : 'allow'}, {id : '885687da-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateServiceOffering', permission : 'allow'}, {id : '8856930f-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateSnapshotPolicy', permission : 'allow'}, {id : '88569a86-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateTemplate', permission : 'allow'}, {id : '8856a23a-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateTemplatePermissions', permission : 'allow'}, {id : '8856a958-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateUser', permission : 'allow'}, {id : '8856b160-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateVMAffinityGroup', permission : 'allow'}, {id : '8856b6a5-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateVPC', permission : 'allow'}, {id : '8856bcab-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateVirtualMachine', permission : 'allow'}, {id : '8856c1f0-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateVmNicIp', permission : 'allow'}, {id : '8856c616-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateVpnConnection', permission : 'allow'}, {id : '8856cde0-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateVpnCustomerGateway', permission : 'allow'}, {id : '8856d641-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'updateVpnGateway', permission : 'allow'}, {id : '885952ab-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'uploadSslCert', permission : 'allow'}, {id : '885963f4-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'uploadVolume', permission : 'allow'}, {id : 'ae36dfee-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'deleteUserKeys', permission : 'allow'}, {id : 'ae37cc6e-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'listUserKeyRules', permission : 'allow'}, {id : '8a4bd354-d1fe-11f1-81aa-1e0044000301', roleid : '87d8715d-d1fe-11f1-81aa-1e0044000301', rolename : 'Resource Admin', rule : 'createSnapshotFromVMSnapshot', permission : 'allow'}]
2026-10-27 14:51:42,493 - DEBUG - Payload: {'roleid': 3, 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'FUaTDeq5ya0ba/xjiPvG6yMI/kk='}
2026-10-27 14:51:42,494 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:42,515 - DEBUG - Response : [{id : '88596c84-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'activateProject', permission : 'allow'}, {id : '93e8b956-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'addAnnotation', permission : 'allow'}, {id : '9b3f98f2-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'assignVolume', permission : 'allow'}, {id : '9afddb73-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'isAccountAllowedToCreateOfferingsWithTags', permission : 'allow'}, {id : '93e8718f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listAnnotations', permission : 'allow'}, {id : '93e8e010-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'removeAnnotation', permission : 'allow'}, {id : '885972ad-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'addAccountToProject', permission : 'allow'}, {id : '88597b1f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'addIpToNic', permission : 'allow'}, {id : '88598475-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'addNicToVirtualMachine', permission : 'allow'}, {id : '885989e6-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'addVpnUser', permission : 'allow'}, {id : '885996b3-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'archiveEvents', permission : 'allow'}, {id : '88599d60-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'assignCertToLoadBalancer', permission : 'allow'}, {id : '8859a2a8-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'assignToGlobalLoadBalancerRule', permission : 'allow'}, {id : '8859a702-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'assignToLoadBalancerRule', permission : 'allow'}, {id : '8859ab10-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'assignVirtualMachine', permission : 'allow'}, {id : '8859aefb-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'associateIpAddress', permission : 'allow'}, {id : '8859b851-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'attachIso', permission : 'allow'}, {id : '8859c1d8-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'attachVolume', permission : 'allow'}, {id : '8859ca66-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'authorizeSamlSso', permission : 'allow'}, {id : '8859d0e5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'authorizeSecurityGroupEgress', permission : 'allow'}, {id : '8859d842-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'authorizeSecurityGroupIngress', permission : 'allow'}, {id : '8859e16c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'changeServiceForRouter', permission : 'allow'}, {id : '8859e8ce-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'changeServiceForVirtualMachine', permission : 'allow'}, {id : '8859f039-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'configureInternalLoadBalancerElement', permission : 'allow'}, {id : '8859f535-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'configureOvsElement', permission : 'allow'}, {id : '8859f990-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'configureVirtualRouterElement', permission : 'allow'}, {id : '885a00be-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'copyIso', permission : 'allow'}, {id : '885a0e27-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'copyTemplate', permission : 'allow'}, {id : '885a1719-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createAccount', permission : 'allow'}, {id : '885a1cb0-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createAffinityGroup', permission : 'allow'}, {id : '885a2480-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createAutoScalePolicy', permission : 'allow'}, {id : '885a3007-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createAutoScaleVmGroup', permission : 'allow'}, {id : '885a37f7-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createAutoScaleVmProfile', permission : 'allow'}, {id : '885a455e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createCondition', permission : 'allow'}, {id : '885a4d31-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createDiskOffering', permission : 'allow'}, {id : '885a5343-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createEgressFirewallRule', permission : 'allow'}, {id : '885a5a98-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createFirewallRule', permission : 'allow'}, {id : '885a5f0f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createGlobalLoadBalancerRule', permission : 'allow'}, {id : '885a6b4a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createInstanceGroup', permission : 'allow'}, {id : '885a7c02-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createInternalLoadBalancerElement', permission : 'allow'}, {id : '885a84f6-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createIpForwardingRule', permission : 'allow'}, {id : '885a8a4d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createLBHealthCheckPolicy', permission : 'allow'}, {id : '885a8f39-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createLBStickinessPolicy', permission : 'allow'}, {id : '885a9376-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createLoadBalancer', permission : 'allow'}, {id : '885a9871-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createLoadBalancerRule', permission : 'allow'}, {id : '885aa3c2-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createNetwork', permission : 'allow'}, {id : '885b52f8-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createNetworkACL', permission : 'allow'}, {id : '885b5de9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createNetworkACLList', permission : 'allow'}, {id : '885b6a4b-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createOvsElement', permission : 'allow'}, {id : '885b8183-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createPortForwardingRule', permission : 'allow'}, {id : '885b89f9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createProject', permission : 'allow'}, {id : '885b9470-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createRemoteAccessVpn', permission : 'allow'}, {id : '885b9ca9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createSSHKeyPair', permission : 'allow'}, {id : '885ba2c9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createSecurityGroup', permission : 'allow'}, {id : '885ba779-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createServiceOffering', permission : 'allow'}, {id : '885bab92-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createSnapshot', permission : 'allow'}, {id : '885bb30e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createSnapshotPolicy', permission : 'allow'}, {id : '885bb958-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createStaticRoute', permission : 'allow'}, {id : '885bc1c4-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createTags', permission : 'allow'}, {id : '885bcbb0-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createTemplate', permission : 'allow'}, {id : '885bd268-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createUser', permission : 'allow'}, {id : '885bd8b5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createVMSnapshot', permission : 'allow'}, {id : '885be10d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createVPC', permission : 'allow'}, {id : '885be6cf-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createVirtualRouterElement', permission : 'allow'}, {id : '885beb9b-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createVolume', permission : 'allow'}, {id : '885bf497-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createVpnConnection', permission : 'allow'}, {id : '885bfb36-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createVpnCustomerGateway', permission : 'allow'}, {id : '885c02dc-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createVpnGateway', permission : 'allow'}, {id : '885c09f7-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteAccount', permission : 'allow'}, {id : '885c111d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteAccountFromProject', permission : 'allow'}, {id : '885c1950-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteAffinityGroup', permission : 'allow'}, {id : '885c2026-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteAutoScalePolicy', permission : 'allow'}, {id : '885c25b3-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteAutoScaleVmGroup', permission : 'allow'}, {id : '885c34cc-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteAutoScaleVmProfile', permission : 'allow'}, {id : '885c3f5f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteCondition', permission : 'allow'}, {id : '885c4808-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteDiskOffering', permission : 'allow'}, {id : '885c4f62-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteEgressFirewallRule', permission : 'allow'}, {id : '885c5793-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteEvents', permission : 'allow'}, {id : '885c5f1d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteFirewallRule', permission : 'allow'}, {id : '885c8f09-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteGlobalLoadBalancerRule', permission : 'allow'}, {id : '885c981f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteInstanceGroup', permission : 'allow'}, {id : '885cf0b4-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteIpForwardingRule', permission : 'allow'}, {id : '885d005f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteIso', permission : 'allow'}, {id : '885d0e06-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteLBHealthCheckPolicy', permission : 'allow'}, {id : '885d199c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteLBStickinessPolicy', permission : 'allow'}, {id : '885d2051-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteLoadBalancer', permission : 'allow'}, {id : '886000f5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteLoadBalancerRule', permission : 'allow'}, {id : '88601250-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteNetwork', permission : 'allow'}, {id : '88601f9e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteNetworkACL', permission : 'allow'}, {id : '88602b76-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteNetworkACLList', permission : 'allow'}, {id : '88603ce6-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deletePortForwardingRule', permission : 'allow'}, {id : '886045a1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteProject', permission : 'allow'}, {id : '886057a7-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteProjectInvitation', permission : 'allow'}, {id : '88606202-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteRemoteAccessVpn', permission : 'allow'}, {id : '886069cc-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteSSHKeyPair', permission : 'allow'}, {id : '88607491-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteSecurityGroup', permission : 'allow'}, {id : '88607b2a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteServiceOffering', permission : 'allow'}, {id : '88608646-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteSnapshot', permission : 'allow'}, {id : '88608f05-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteSnapshotPolicies', permission : 'allow'}, {id : '8860997c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteSslCert', permission : 'allow'}, {id : '8860a146-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteStaticRoute', permission : 'allow'}, {id : '8860a875-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteTags', permission : 'allow'}, {id : '8860b373-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteTemplate', permission : 'allow'}, {id : '8860bc96-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteUser', permission : 'allow'}, {id : '8860c457-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteVMSnapshot', permission : 'allow'}, {id : '8860c9b8-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteVPC', permission : 'allow'}, {id : '8860d079-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteVolume', permission : 'allow'}, {id : '8860d924-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteVpnConnection', permission : 'allow'}, {id : '8860e40e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteVpnCustomerGateway', permission : 'allow'}, {id : '8860eb2a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteVpnGateway', permission : 'allow'}, {id : '8860f0bf-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deployVirtualMachine', permission : 'allow'}, {id : '8860fe3a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'destroyRouter', permission : 'allow'}, {id : '8861043d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'destroyVirtualMachine', permission : 'allow'}, {id : '88611725-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'detachIso', permission : 'allow'}, {id : '88611eab-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'detachVolume', permission : 'allow'}, {id : '88612517-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'disableAccount', permission : 'allow'}, {id : '88612c82-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'disableAutoScaleVmGroup', permission : 'allow'}, {id : '88613673-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'disableStaticNat', permission : 'allow'}, {id : '88613c03-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'disableUser', permission : 'allow'}, {id : '8861454a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'disassociateIpAddress', permission : 'allow'}, {id : '886152c3-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'enableAccount', permission : 'allow'}, {id : '88615b9e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'enableAutoScaleVmGroup', permission : 'allow'}, {id : '886161ba-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'enableStaticNat', permission : 'allow'}, {id : '8861672d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'enableUser', permission : 'allow'}, {id : '88616eb6-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'expungeVirtualMachine', permission : 'allow'}, {id : '8861740c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'extractIso', permission : 'allow'}, {id : '8861791e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'extractTemplate', permission : 'allow'}, {id : '88617dda-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'extractVolume', permission : 'allow'}, {id : '886182b7-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'getApiLimit', permission : 'allow'}, {id : '886186aa-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'getCloudIdentifier', permission : 'allow'}, {id : '88618d59-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'getSolidFireAccountId', permission : 'allow'}, {id : '88619320-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'getSolidFireVolumeAccessGroupId', permission : 'allow'}, {id : '88619763-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'getSolidFireVolumeIscsiName', permission : 'allow'}, {id : '88619b28-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'getSolidFireVolumeSize', permission : 'allow'}, {id : '88619ed8-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'getUploadParamsForTemplate', permission : 'allow'}, {id : '8861a271-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'getUploadParamsForVolume', permission : 'allow'}, {id : '8861a8ee-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'getVMPassword', permission : 'allow'}, {id : '8861aea9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'getVirtualMachineUserData', permission : 'allow'}, {id : '8861b2f0-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listAccounts', permission : 'allow'}, {id : '8861b86f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listAffinityGroupTypes', permission : 'allow'}, {id : '8861bca3-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listAffinityGroups', permission : 'allow'}, {id : '8861c07d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listApis', permission : 'allow'}, {id : '8861c49c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listAsyncJobs', permission : 'allow'}, {id : '8861c872-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listAutoScalePolicies', permission : 'allow'}, {id : '8861ce53-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listAutoScaleVmGroups', permission : 'allow'}, {id : '8861d63a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listAutoScaleVmProfiles', permission : 'allow'}, {id : '8861e3c0-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listCapabilities', permission : 'allow'}, {id : '8861eec1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listConditions', permission : 'allow'}, {id : '8861f80c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listCounters', permission : 'allow'}, {id : '88620081-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listDiskOfferings', permission : 'allow'}, {id : '8862084c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listDomainChildren', permission : 'allow'}, {id : '88620fda-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listDomains', permission : 'allow'}, {id : '8862dda5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listEgressFirewallRules', permission : 'allow'}, {id : '8862ec1f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listEventTypes', permission : 'allow'}, {id : '8862f6ea-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listEvents', permission : 'allow'}, {id : '8862ff55-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listFirewallRules', permission : 'allow'}, {id : '886308e3-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listGlobalLoadBalancerRules', permission : 'allow'}, {id : '88631203-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listHostTags', permission : 'allow'}, {id : '88631b6a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listHypervisors', permission : 'allow'}, {id : '8863249a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listInstanceGroups', permission : 'allow'}, {id : '88632c2e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listInternalLoadBalancerElements', permission : 'allow'}, {id : '886334e3-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listIpForwardingRules', permission : 'allow'}, {id : '886341d5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listIsoPermissions', permission : 'allow'}, {id : '88634ca2-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listIsos', permission : 'allow'}, {id : '886355e5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listLBHealthCheckPolicies', permission : 'allow'}, {id : '88635c03-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listLBStickinessPolicies', permission : 'allow'}, {id : '88636309-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listLdapConfigurations', permission : 'allow'}, {id : '88636c93-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listLoadBalancerRuleInstances', permission : 'allow'}, {id : '88637435-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listLoadBalancerRules', permission : 'allow'}, {id : '88637a87-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listLoadBalancers', permission : 'allow'}, {id : '886383a1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listNetworkACLLists', permission : 'allow'}, {id : '8863877b-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listNetworkACLs', permission : 'allow'}, {id : '88638e04-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listNetworkOfferings', permission : 'allow'}, {id : '8863951d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listNetworks', permission : 'allow'}, {id : '88639bfe-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listNics', permission : 'allow'}, {id : '8863a2f0-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listOsCategories', permission : 'allow'}, {id : '8863a80a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listOsTypes', permission : 'allow'}, {id : '8863ad2f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listOvsElements', permission : 'allow'}, {id : '8863b9e1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listPortForwardingRules', permission : 'allow'}, {id : '8863c0e2-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listPrivateGateways', permission : 'allow'}, {id : '8863c97b-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listProjectAccounts', permission : 'allow'}, {id : '8863cfb5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listProjectInvitations', permission : 'allow'}, {id : '8863d5e7-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listProjects', permission : 'allow'}, {id : '88658a2f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listPublicIpAddresses', permission : 'allow'}, {id : '8865a10c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listRegions', permission : 'allow'}, {id : '8865aeb3-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listRemoteAccessVpns', permission : 'allow'}, {id : '8865b6d8-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listResourceDetails', permission : 'allow'}, {id : '8865bfa1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listResourceLimits', permission : 'allow'}, {id : '8865c772-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listRouters', permission : 'allow'}, {id : '8865cfbd-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listSSHKeyPairs', permission : 'allow'}, {id : '8865d64c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listSamlAuthorization', permission : 'allow'}, {id : '8865db20-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listSecurityGroups', permission : 'allow'}, {id : '8865e0c6-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listServiceOfferings', permission : 'allow'}, {id : '8865ea03-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listSnapshotPolicies', permission : 'allow'}, {id : '8865f6d7-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listSnapshots', permission : 'allow'}, {id : '8866053d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listSslCerts', permission : 'allow'}, {id : '88660f06-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listStaticRoutes', permission : 'allow'}, {id : '88661755-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listStorageTags', permission : 'allow'}, {id : '88661c3e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listTags', permission : 'allow'}, {id : '88662060-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listTemplatePermissions', permission : 'allow'}, {id : '88662632-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listTemplates', permission : 'allow'}, {id : '88662b1d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listUsageRecords', permission : 'allow'}, {id : '88663066-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listUsers', permission : 'allow'}, {id : '886634a7-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listVMSnapshot', permission : 'allow'}, {id : '88663c45-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listVPCOfferings', permission : 'allow'}, {id : '88664120-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listVPCs', permission : 'allow'}, {id : '886645b7-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listVirtualMachines', permission : 'allow'}, {id : '886649da-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listVirtualRouterElements', permission : 'allow'}, {id : '8866524a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listVolumes', permission : 'allow'}, {id : '88665f13-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listVpnConnections', permission : 'allow'}, {id : '88666425-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listVpnCustomerGateways', permission : 'allow'}, {id : '8866684d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listVpnGateways', permission : 'allow'}, {id : '88666c32-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listVpnUsers', permission : 'allow'}, {id : '8866701d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listZones', permission : 'allow'}, {id : '88667712-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'lockAccount', permission : 'allow'}, {id : '886681c9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'lockUser', permission : 'allow'}, {id : '886699b1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'queryAsyncJobResult', permission : 'allow'}, {id : '88669f92-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'quotaBalance', permission : 'allow'}, {id : '8866a697-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'quotaIsEnabled', permission : 'allow'}, {id : 'a8623026-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'quotaCreditsList', permission : 'allow'}, {id : 'afb4eeea-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'quotaResourceStatement', permission : 'allow'}, {id : '8866af25-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'quotaStatement', permission : 'allow'}, {id : '8866b4d8-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'quotaSummary', permission : 'allow'}, {id : '8866b96e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'quotaTariffList', permission : 'allow'}, {id : '8866be8b-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'rebootRouter', permission : 'allow'}, {id : '8866c39d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'rebootVirtualMachine', permission : 'allow'}, {id : '8866c7b8-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'recoverVirtualMachine', permission : 'allow'}, {id : '8866cd73-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'registerIso', permission : 'allow'}, {id : '8866d82c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'registerSSHKeyPair', permission : 'allow'}, {id : '8866e041-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'registerTemplate', permission : 'allow'}, {id : '8866e75c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'registerUserKeys', permission : 'allow'}, {id : '8866ecc4-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'removeCertFromLoadBalancer', permission : 'allow'}, {id : '8866f24b-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'removeFromGlobalLoadBalancerRule', permission : 'allow'}, {id : '8866fc42-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'removeFromLoadBalancerRule', permission : 'allow'}, {id : '886704f3-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'removeIpFromNic', permission : 'allow'}, {id : '88670bdc-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'removeNicFromVirtualMachine', permission : 'allow'}, {id : '886711e4-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'removeVpnUser', permission : 'allow'}, {id : '88671805-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'replaceNetworkACLList', permission : 'allow'}, {id : '88671cf9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'resetPasswordForVirtualMachine', permission : 'allow'}, {id : '886721ad-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'resetSSHKeyForVirtualMachine', permission : 'allow'}, {id : '88672795-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'resetVpnConnection', permission : 'allow'}, {id : '886731a5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'resizeVolume', permission : 'allow'}, {id : '88673c0e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'restartNetwork', permission : 'allow'}, {id : '886744fb-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'restartVPC', permission : 'allow'}, {id : '88674e03-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'restoreVirtualMachine', permission : 'allow'}, {id : '88675566-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'revertSnapshot', permission : 'allow'}, {id : '88675b30-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'revertToVMSnapshot', permission : 'allow'}, {id : '88675fc5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'revokeSecurityGroupEgress', permission : 'allow'}, {id : '88676870-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'revokeSecurityGroupIngress', permission : 'allow'}, {id : '88676d8d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'scaleVirtualMachine', permission : 'allow'}, {id : '88677307-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'startRouter', permission : 'allow'}, {id : '88677758-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'startVirtualMachine', permission : 'allow'}, {id : '88677b32-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'stopRouter', permission : 'allow'}, {id : '88677f7d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'stopVirtualMachine', permission : 'allow'}, {id : '8867836a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'suspendProject', permission : 'allow'}, {id : '886788c9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateAccount', permission : 'allow'}, {id : '886791df-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateAutoScalePolicy', permission : 'allow'}, {id : '88679d0e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateAutoScaleVmGroup', permission : 'allow'}, {id : '8867a470-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateAutoScaleVmProfile', permission : 'allow'}, {id : '8867a979-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateDefaultNicForVirtualMachine', permission : 'allow'}, {id : '8867adbc-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateDiskOffering', permission : 'allow'}, {id : '8867b3af-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateEgressFirewallRule', permission : 'allow'}, {id : '8867bb03-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateFirewallRule', permission : 'allow'}, {id : '8867c373-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateGlobalLoadBalancerRule', permission : 'allow'}, {id : '8867cc33-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateInstanceGroup', permission : 'allow'}, {id : '8867d634-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateIpAddress', permission : 'allow'}, {id : '8867dfcf-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateIso', permission : 'allow'}, {id : '8867e953-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateIsoPermissions', permission : 'allow'}, {id : '8867f199-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateLBHealthCheckPolicy', permission : 'allow'}, {id : '8867fabd-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateLBStickinessPolicy', permission : 'allow'}, {id : '8868048a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateLoadBalancer', permission : 'allow'}, {id : '88680f1e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateLoadBalancerRule', permission : 'allow'}, {id : '88681940-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateNetwork', permission : 'allow'}, {id : '886821f6-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateNetworkACLItem', permission : 'allow'}, {id : '88682b81-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateNetworkACLList', permission : 'allow'}, {id : '886833e1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updatePortForwardingRule', permission : 'allow'}, {id : '88683b0b-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateProject', permission : 'allow'}, {id : '88684047-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateProjectInvitation', permission : 'allow'}, {id : '886844b2-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateRemoteAccessVpn', permission : 'allow'}, {id : '886848d6-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateResourceCount', permission : 'allow'}, {id : '88684dd7-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateResourceLimit', permission : 'allow'}, {id : '8869cd80-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateServiceOffering', permission : 'allow'}, {id : '8869db86-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateSnapshotPolicy', permission : 'allow'}, {id : '8869e8a2-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateTemplate', permission : 'allow'}, {id : '8869f012-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateTemplatePermissions', permission : 'allow'}, {id : '8869f666-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateUser', permission : 'allow'}, {id : '8869fb6d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateVMAffinityGroup', permission : 'allow'}, {id : '886a0646-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateVPC', permission : 'allow'}, {id : '886a1260-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateVirtualMachine', permission : 'allow'}, {id : '886a187e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateVmNicIp', permission : 'allow'}, {id : '886a1ced-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateVpnConnection', permission : 'allow'}, {id : '886a2107-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateVpnCustomerGateway', permission : 'allow'}, {id : '886a27d9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateVpnGateway', permission : 'allow'}, {id : '886a2d55-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'uploadSslCert', permission : 'allow'}, {id : '886a3526-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'uploadVolume', permission : 'allow'}, {id : '8a4be3bd-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'createSnapshotFromVMSnapshot', permission : 'allow'}, {id : '8cf337dd-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'moveNetworkAclItem', permission : 'allow'}, {id : '96e470b1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listConfigurations', permission : 'allow'}, {id : 'ae369c48-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'deleteUserKeys', permission : 'allow'}, {id : 'ae37681f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'listUserKeyRules', permission : 'allow'}, {id : '96e4aa52-d1fe-11f1-81aa-1e0044000301', roleid : '87d88360-d1fe-11f1-81aa-1e0044000301', rolename : 'Domain Admin', rule : 'updateConfiguration', permission : 'allow'}]
2026-10-27 14:51:42,516 - DEBUG - Payload: {'roleid': 4, 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'LMSKVyo3sLvMU8Mn1g0nGOjrQZ0='}
2026-10-27 14:51:42,516 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:42,864 - DEBUG - Response : [{id : '886a3a1d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'activateProject', permission : 'allow'}, {id : '93e97ca6-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'addAnnotation', permission : 'allow'}, {id : '93e93062-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listAnnotations', permission : 'allow'}, {id : '93e9ab82-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'removeAnnotation', permission : 'allow'}, {id : '886a3e42-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'addAccountToProject', permission : 'allow'}, {id : '886a4210-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'addIpToNic', permission : 'allow'}, {id : '886a45cf-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'addNicToVirtualMachine', permission : 'allow'}, {id : '886a4a52-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'addVpnUser', permission : 'allow'}, {id : '886a4e43-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'archiveEvents', permission : 'allow'}, {id : '886a5277-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'assignCertToLoadBalancer', permission : 'allow'}, {id : '886a582a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'assignToGlobalLoadBalancerRule', permission : 'allow'}, {id : '886a5d15-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'assignToLoadBalancerRule', permission : 'allow'}, {id : '886a61da-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'associateIpAddress', permission : 'allow'}, {id : '886a6a5f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'attachIso', permission : 'allow'}, {id : '886a6fa9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'attachVolume', permission : 'allow'}, {id : '886a8045-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'authorizeSecurityGroupEgress', permission : 'allow'}, {id : '886a8958-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'authorizeSecurityGroupIngress', permission : 'allow'}, {id : '886a8eb9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'changeServiceForVirtualMachine', permission : 'allow'}, {id : '886a9302-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'copyIso', permission : 'allow'}, {id : '886a9747-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'copyTemplate', permission : 'allow'}, {id : '886a9b2d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createAffinityGroup', permission : 'allow'}, {id : '886a9f08-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createAutoScalePolicy', permission : 'allow'}, {id : '886aa2ef-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createAutoScaleVmGroup', permission : 'allow'}, {id : '886aa900-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createAutoScaleVmProfile', permission : 'allow'}, {id : '886aae22-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createCondition', permission : 'allow'}, {id : '886ab4c5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createEgressFirewallRule', permission : 'allow'}, {id : '886abac5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createFirewallRule', permission : 'allow'}, {id : '886ac14d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createGlobalLoadBalancerRule', permission : 'allow'}, {id : '886acdfb-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createInstanceGroup', permission : 'allow'}, {id : '886ad9e6-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createIpForwardingRule', permission : 'allow'}, {id : '886ae34c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createLBHealthCheckPolicy', permission : 'allow'}, {id : '886aee1c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createLBStickinessPolicy', permission : 'allow'}, {id : '886af6f4-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createLoadBalancer', permission : 'allow'}, {id : '886c1afc-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createLoadBalancerRule', permission : 'allow'}, {id : '886c332d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createNetwork', permission : 'allow'}, {id : '886c3d1a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createNetworkACL', permission : 'allow'}, {id : '886c43e2-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createNetworkACLList', permission : 'allow'}, {id : '886c4e33-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createPortForwardingRule', permission : 'allow'}, {id : '886c5416-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createProject', permission : 'allow'}, {id : '886c5a74-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createRemoteAccessVpn', permission : 'allow'}, {id : '886c6153-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createSSHKeyPair', permission : 'allow'}, {id : '886c6945-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createSecurityGroup', permission : 'allow'}, {id : '886c6e56-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createSnapshot', permission : 'allow'}, {id : '886c7268-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createSnapshotPolicy', permission : 'allow'}, {id : '886c766a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createStaticRoute', permission : 'allow'}, {id : '886c7c13-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createTags', permission : 'allow'}, {id : '886c84c3-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createTemplate', permission : 'allow'}, {id : '886c8c24-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createVMSnapshot', permission : 'allow'}, {id : '886c9351-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createVPC', permission : 'allow'}, {id : '886c996c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createVolume', permission : 'allow'}, {id : '886ca7bd-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createVpnConnection', permission : 'allow'}, {id : '886cb447-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createVpnCustomerGateway', permission : 'allow'}, {id : '886cbdbd-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createVpnGateway', permission : 'allow'}, {id : '886cc3b7-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteAccountFromProject', permission : 'allow'}, {id : '886cca39-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteAffinityGroup', permission : 'allow'}, {id : '886ccfdc-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteAutoScalePolicy', permission : 'allow'}, {id : '886cd4ab-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteAutoScaleVmGroup', permission : 'allow'}, {id : '886cd9d7-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteAutoScaleVmProfile', permission : 'allow'}, {id : '886cdee7-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteCondition', permission : 'allow'}, {id : '886ce4b5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteEgressFirewallRule', permission : 'allow'}, {id : '886ce929-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteEvents', permission : 'allow'}, {id : '886cede4-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteFirewallRule', permission : 'allow'}, {id : '886cf39c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteGlobalLoadBalancerRule', permission : 'allow'}, {id : '886cf7ab-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteInstanceGroup', permission : 'allow'}, {id : '886cfc12-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteIpForwardingRule', permission : 'allow'}, {id : '886d035b-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteIso', permission : 'allow'}, {id : '886d0893-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteLBHealthCheckPolicy', permission : 'allow'}, {id : '886d0dc6-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteLBStickinessPolicy', permission : 'allow'}, {id : '886d128e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteLoadBalancer', permission : 'allow'}, {id : '886d2099-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteLoadBalancerRule', permission : 'allow'}, {id : '886d2814-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteNetwork', permission : 'allow'}, {id : '886d2d09-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteNetworkACL', permission : 'allow'}, {id : '886d31c0-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteNetworkACLList', permission : 'allow'}, {id : '886d3a26-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deletePortForwardingRule', permission : 'allow'}, {id : '886d40e1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteProject', permission : 'allow'}, {id : '886d4bf9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteProjectInvitation', permission : 'allow'}, {id : '886d51a3-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteRemoteAccessVpn', permission : 'allow'}, {id : '886d55f3-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteSSHKeyPair', permission : 'allow'}, {id : '886d5a66-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteSecurityGroup', permission : 'allow'}, {id : '886d5e8d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteSnapshot', permission : 'allow'}, {id : '886d631c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteSnapshotPolicies', permission : 'allow'}, {id : '886d68d0-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteSslCert', permission : 'allow'}, {id : '886d6da6-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteStaticRoute', permission : 'allow'}, {id : '886d72b9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteTags', permission : 'allow'}, {id : '886d7aa0-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteTemplate', permission : 'allow'}, {id : '886d7f29-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteVMSnapshot', permission : 'allow'}, {id : '886d8355-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteVPC', permission : 'allow'}, {id : '886d87bf-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteVolume', permission : 'allow'}, {id : '886d8e22-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteVpnConnection', permission : 'allow'}, {id : '886d92e1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteVpnCustomerGateway', permission : 'allow'}, {id : '886d9731-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteVpnGateway', permission : 'allow'}, {id : '886d9ded-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deployVirtualMachine', permission : 'allow'}, {id : '886da7e5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'destroyVirtualMachine', permission : 'allow'}, {id : '886db94b-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'detachIso', permission : 'allow'}, {id : '886dbe81-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'detachVolume', permission : 'allow'}, {id : '886dc683-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'disableAutoScaleVmGroup', permission : 'allow'}, {id : '886dd021-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'disableStaticNat', permission : 'allow'}, {id : '886dd60f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'disassociateIpAddress', permission : 'allow'}, {id : '886de327-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'enableAutoScaleVmGroup', permission : 'allow'}, {id : '886de8b3-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'enableStaticNat', permission : 'allow'}, {id : '886df359-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'expungeVirtualMachine', permission : 'allow'}, {id : '886df991-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'extractIso', permission : 'allow'}, {id : '886dfdf0-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'extractTemplate', permission : 'allow'}, {id : '886e03c9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'extractVolume', permission : 'allow'}, {id : '886e0959-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'getApiLimit', permission : 'allow'}, {id : '886e0dc4-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'getCloudIdentifier', permission : 'allow'}, {id : '886e11bf-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'getSolidFireAccountId', permission : 'allow'}, {id : '886e17ee-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'getSolidFireVolumeAccessGroupId', permission : 'allow'}, {id : '886e1f80-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'getSolidFireVolumeIscsiName', permission : 'allow'}, {id : '886e2874-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'getSolidFireVolumeSize', permission : 'allow'}, {id : '886e2fad-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'getUploadParamsForTemplate', permission : 'allow'}, {id : '886e359c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'getUploadParamsForVolume', permission : 'allow'}, {id : '886e3ce3-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'getVMPassword', permission : 'allow'}, {id : '886e4672-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'getVirtualMachineUserData', permission : 'allow'}, {id : '886e52c0-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listAccounts', permission : 'allow'}, {id : '886e5c31-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listAffinityGroupTypes', permission : 'allow'}, {id : '886e6551-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listAffinityGroups', permission : 'allow'}, {id : '886e6f65-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listApis', permission : 'allow'}, {id : '886e7b26-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listAsyncJobs', permission : 'allow'}, {id : '886e84ba-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listAutoScalePolicies', permission : 'allow'}, {id : '886e8df5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listAutoScaleVmGroups', permission : 'allow'}, {id : '886e975f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listAutoScaleVmProfiles', permission : 'allow'}, {id : '886ea0bb-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listCapabilities', permission : 'allow'}, {id : '886ea7a9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listConditions', permission : 'allow'}, {id : '886ead27-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listCounters', permission : 'allow'}, {id : '886eb477-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listDiskOfferings', permission : 'allow'}, {id : '886eb928-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listEgressFirewallRules', permission : 'allow'}, {id : '886ebd58-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listEventTypes', permission : 'allow'}, {id : '886ec143-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listEvents', permission : 'allow'}, {id : '886ec856-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listFirewallRules', permission : 'allow'}, {id : '886ecefe-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listGlobalLoadBalancerRules', permission : 'allow'}, {id : '886ed714-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listHypervisors', permission : 'allow'}, {id : '887fd643-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listInstanceGroups', permission : 'allow'}, {id : '887ff96c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listIpForwardingRules', permission : 'allow'}, {id : '88801b34-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listIsoPermissions', permission : 'allow'}, {id : '88802cef-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listIsos', permission : 'allow'}, {id : '88803ebd-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listLBHealthCheckPolicies', permission : 'allow'}, {id : '88804939-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listLBStickinessPolicies', permission : 'allow'}, {id : '888057d9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listLdapConfigurations', permission : 'allow'}, {id : '88806465-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listLoadBalancerRuleInstances', permission : 'allow'}, {id : '88806c73-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listLoadBalancerRules', permission : 'allow'}, {id : '88807321-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listLoadBalancers', permission : 'allow'}, {id : '88808e96-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listNetworkACLLists', permission : 'allow'}, {id : '888096ed-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listNetworkACLs', permission : 'allow'}, {id : '8880a458-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listNetworkOfferings', permission : 'allow'}, {id : '8880b219-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listNetworks', permission : 'allow'}, {id : '8880bdfb-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listNics', permission : 'allow'}, {id : '8880ce2f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listOsCategories', permission : 'allow'}, {id : '8880db74-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listOsTypes', permission : 'allow'}, {id : '8880f3fd-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listPortForwardingRules', permission : 'allow'}, {id : '8880feae-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listPrivateGateways', permission : 'allow'}, {id : '88810eb8-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listProjectAccounts', permission : 'allow'}, {id : '88811d8e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listProjectInvitations', permission : 'allow'}, {id : '888126d8-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listProjects', permission : 'allow'}, {id : '888132f0-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listPublicIpAddresses', permission : 'allow'}, {id : '888140ce-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listRegions', permission : 'allow'}, {id : '888148ef-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listRemoteAccessVpns', permission : 'allow'}, {id : '888150f9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listResourceDetails', permission : 'allow'}, {id : '888164cf-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listResourceLimits', permission : 'allow'}, {id : '888197b5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listSSHKeyPairs', permission : 'allow'}, {id : '8881aa0c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listSecurityGroups', permission : 'allow'}, {id : '8881bc06-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listServiceOfferings', permission : 'allow'}, {id : '8886afee-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listSnapshotPolicies', permission : 'allow'}, {id : '8886d043-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listSnapshots', permission : 'allow'}, {id : '8886dc59-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listSslCerts', permission : 'allow'}, {id : '8886e830-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listStaticRoutes', permission : 'allow'}, {id : '8886f3ad-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listTags', permission : 'allow'}, {id : '88870494-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listTemplatePermissions', permission : 'allow'}, {id : '888c80b6-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listTemplates', permission : 'allow'}, {id : '888c91ce-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listUsers', permission : 'allow'}, {id : '888ca3c1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listVMSnapshot', permission : 'allow'}, {id : '888cade8-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listVPCOfferings', permission : 'allow'}, {id : '888cb937-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listVPCs', permission : 'allow'}, {id : '888cc4fc-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listVirtualMachines', permission : 'allow'}, {id : '888cd07b-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listVolumes', permission : 'allow'}, {id : '888ce9f1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listVpnConnections', permission : 'allow'}, {id : '888cf64f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listVpnCustomerGateways', permission : 'allow'}, {id : '888d0041-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listVpnGateways', permission : 'allow'}, {id : '888d0628-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listVpnUsers', permission : 'allow'}, {id : '888d0ac4-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listZones', permission : 'allow'}, {id : '888d1b67-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'queryAsyncJobResult', permission : 'allow'}, {id : '888d2653-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'quotaBalance', permission : 'allow'}, {id : '888d2fa4-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'quotaIsEnabled', permission : 'allow'}, {id : 'a8623416-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'quotaCreditsList', permission : 'allow'}, {id : 'afb4f257-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'quotaResourceStatement', permission : 'allow'}, {id : '888d35d4-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'quotaStatement', permission : 'allow'}, {id : '888d3a51-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'quotaSummary', permission : 'allow'}, {id : '888d3e61-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'quotaTariffList', permission : 'allow'}, {id : '888d42b5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'rebootVirtualMachine', permission : 'allow'}, {id : '888d4a9c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'recoverVirtualMachine', permission : 'allow'}, {id : '888d5234-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'registerIso', permission : 'allow'}, {id : '888d5ad9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'registerSSHKeyPair', permission : 'allow'}, {id : '888d6083-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'registerTemplate', permission : 'allow'}, {id : '888d6545-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'registerUserKeys', permission : 'allow'}, {id : '888d6a6c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'removeCertFromLoadBalancer', permission : 'allow'}, {id : '888d72bc-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'removeFromGlobalLoadBalancerRule', permission : 'allow'}, {id : '888d79e4-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'removeFromLoadBalancerRule', permission : 'allow'}, {id : '888d81e0-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'removeIpFromNic', permission : 'allow'}, {id : '888d8928-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'removeNicFromVirtualMachine', permission : 'allow'}, {id : '888d9b39-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'removeVpnUser', permission : 'allow'}, {id : '888da552-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'replaceNetworkACLList', permission : 'allow'}, {id : '888dac0b-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'resetPasswordForVirtualMachine', permission : 'allow'}, {id : '888db187-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'resetSSHKeyForVirtualMachine', permission : 'allow'}, {id : '888db5d2-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'resetVpnConnection', permission : 'allow'}, {id : '888dbccc-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'resizeVolume', permission : 'allow'}, {id : '888dc6db-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'restartNetwork', permission : 'allow'}, {id : '888dce0c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'restartVPC', permission : 'allow'}, {id : '888dd2ee-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'restoreVirtualMachine', permission : 'allow'}, {id : '888dd71e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'revertSnapshot', permission : 'allow'}, {id : '888ddb8a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'revertToVMSnapshot', permission : 'allow'}, {id : '888de0c5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'revokeSecurityGroupEgress', permission : 'allow'}, {id : '888ded1e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'revokeSecurityGroupIngress', permission : 'allow'}, {id : '888df544-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'scaleVirtualMachine', permission : 'allow'}, {id : '888dfba9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'startVirtualMachine', permission : 'allow'}, {id : '888e006e-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'stopVirtualMachine', permission : 'allow'}, {id : '888e0487-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'suspendProject', permission : 'allow'}, {id : '888e0c2a-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateAutoScalePolicy', permission : 'allow'}, {id : '888e1439-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateAutoScaleVmGroup', permission : 'allow'}, {id : '888e1a5c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateAutoScaleVmProfile', permission : 'allow'}, {id : '888e1edf-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateDefaultNicForVirtualMachine', permission : 'allow'}, {id : '888e2300-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateEgressFirewallRule', permission : 'allow'}, {id : '888e2751-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateFirewallRule', permission : 'allow'}, {id : '888e2b37-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateGlobalLoadBalancerRule', permission : 'allow'}, {id : '888e3276-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateInstanceGroup', permission : 'allow'}, {id : '888e3941-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateIpAddress', permission : 'allow'}, {id : '888e4021-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateIso', permission : 'allow'}, {id : '888e4605-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateIsoPermissions', permission : 'allow'}, {id : '888e4bf8-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateLBHealthCheckPolicy', permission : 'allow'}, {id : '888e50d1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateLBStickinessPolicy', permission : 'allow'}, {id : '888e5643-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateLoadBalancer', permission : 'allow'}, {id : '888e5fcf-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateLoadBalancerRule', permission : 'allow'}, {id : '888e6779-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateNetwork', permission : 'allow'}, {id : '888e6ce7-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateNetworkACLItem', permission : 'allow'}, {id : '888e7257-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateNetworkACLList', permission : 'allow'}, {id : '888e76a8-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updatePortForwardingRule', permission : 'allow'}, {id : '888e7af1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateProject', permission : 'allow'}, {id : '888e82f2-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateProjectInvitation', permission : 'allow'}, {id : '888e8a6c-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateRemoteAccessVpn', permission : 'allow'}, {id : '888e9280-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateSnapshotPolicy', permission : 'allow'}, {id : '888e985d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateTemplate', permission : 'allow'}, {id : '888e9d0d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateTemplatePermissions', permission : 'allow'}, {id : '888ea2a4-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateUser', permission : 'allow'}, {id : '888eabc0-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateVMAffinityGroup', permission : 'allow'}, {id : '888eb2e1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateVPC', permission : 'allow'}, {id : '888eb804-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateVirtualMachine', permission : 'allow'}, {id : '888ebca5-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateVmNicIp', permission : 'allow'}, {id : '888ec0bb-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateVpnConnection', permission : 'allow'}, {id : '888ec4a7-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateVpnCustomerGateway', permission : 'allow'}, {id : '888ec96f-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'updateVpnGateway', permission : 'allow'}, {id : '888ed155-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'uploadSslCert', permission : 'allow'}, {id : '888ed81d-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'uploadVolume', permission : 'allow'}, {id : 'ae365378-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'deleteUserKeys', permission : 'allow'}, {id : 'ae372de1-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'listUserKeyRules', permission : 'allow'}, {id : '8a4c8ccd-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'createSnapshotFromVMSnapshot', permission : 'allow'}, {id : '8cf340a9-d1fe-11f1-81aa-1e0044000301', roleid : '87d88f8c-d1fe-11f1-81aa-1e0044000301', rolename : 'User', rule : 'moveNetworkAclItem', permission : 'allow'}]
2026-10-27 14:51:42,865 - DEBUG - Payload: {'id': '7682db45-34a0-4b86-9ebc-a6fe9acaf649', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'2u3Mb914pfz8jU82IPa48YYdoms='}
2026-10-27 14:51:42,866 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:42,900 - DEBUG - === Jobid: 02fcb0fa-396d-443c-9286-bc26ad69a369 Started ===
2026-10-27 14:51:42,900 - DEBUG - Payload: {'jobid': '02fcb0fa-396d-443c-9286-bc26ad69a369', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'uziZLhgrAqgSl5i1DeJohdJOrgk='}
2026-10-27 14:51:42,900 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:42,925 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : '7682db45-34a0-4b86-9ebc-a6fe9acaf649', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:43+0000', jobid : '02fcb0fa-396d-443c-9286-bc26ad69a369', jobstatus : 0}
2026-10-27 14:51:43,927 - DEBUG - === JobId:02fcb0fa-396d-443c-9286-bc26ad69a369 is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:43,927 - DEBUG - Payload: {'jobid': '02fcb0fa-396d-443c-9286-bc26ad69a369', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'uziZLhgrAqgSl5i1DeJohdJOrgk='}
2026-10-27 14:51:43,927 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:43,975 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '7682db45-34a0-4b86-9ebc-a6fe9acaf649', created : '2026-10-27T14:51:43+0000', completed : '2026-10-27T14:51:43+0000', jobid : '02fcb0fa-396d-443c-9286-bc26ad69a369', jobstatus : 1}
2026-10-27 14:51:43,975 - DEBUG - ===Jobid:02fcb0fa-396d-443c-9286-bc26ad69a369 ; StartTime:Tue Oct 27 14:51:42 2026 ; EndTime:Tue Oct 27 14:51:43 2026 ; TotalTime:-1===
2026-10-27 14:51:43,976 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : '7682db45-34a0-4b86-9ebc-a6fe9acaf649', created : '2026-10-27T14:51:43+0000', completed : '2026-10-27T14:51:43+0000', jobid : '02fcb0fa-396d-443c-9286-bc26ad69a369', jobstatus : 1}
2026-10-27 14:51:43,976 - DEBUG - Payload: {'id': 'f3c42f47-99af-4a0c-9b6c-546bb09a883e', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Gs6Rr6mlrlRcLiQnfaWvTjVQAmc='}
2026-10-27 14:51:43,976 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:44,008 - DEBUG - Response : {success : True}
2026-10-27 14:51:44,009 - DEBUG - Payload: {'id': '8e8ca2ac-5870-4e71-8ae5-454b06556224', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'TDAHzYa51WAzQM88fZI1SpiUsZ4='}
2026-10-27 14:51:44,009 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:44,078 - DEBUG - Response : {success : True}
2026-10-27 14:51:44,078 - DEBUG - TestCaseName: test_rolepermission_lifecycle_list; Time Taken: 2 Seconds; StartTime: Tue Oct 27 14:51:41 2026; EndTime: Tue Oct 27 14:51:44 2026; Result: SUCCESS
2026-10-27 14:51:44,078 - DEBUG - ::::::::::::STARTED : TC: test_rolepermission_lifecycle_update :::::::::::
2026-10-27 14:51:44,079 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:44,079 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:44,143 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:44,144 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role pquboudo6u', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Ddg8/TVbHR4JTOINI9A5o7cyyKk='}
2026-10-27 14:51:44,144 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:44,175 - DEBUG - Response : {type : 'User', state : 'enabled', id : '14698441-237b-48e5-abe3-cab9be67456d', name : 'MarvinFake Role pquboudo6u', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:44,176 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '14698441-237b-48e5-abe3-cab9be67456d', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'4/IKxTvfMrGOekYQoSqROMZyqOw='}
2026-10-27 14:51:44,176 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:44,262 - DEBUG - Response : {id : '6ea2dac3-291f-4578-8a14-2dd7ec55abe4', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:44,262 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '14698441-237b-48e5-abe3-cab9be67456d', 'username': 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update-FOJNAD', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'SdQLxRpOiwv0iIyP/BfD6VwEYjE='}
2026-10-27 14:51:44,262 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:45,136 - DEBUG - Response : {id : 'e7689683-98e4-4f45-8711-407951743827', name : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update-FOJNAD', accounttype : 0, roleid : '14698441-237b-48e5-abe3-cab9be67456d', roletype : 'User', rolename : 'MarvinFake Role pquboudo6u', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:45+0000', user : [{id : '916cff30-5e19-4a34-a90c-a6b53b83a086', username : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update-FOJNAD', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:45+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update-FOJNAD', accounttype : 0, usersource : 'native', roleid : '14698441-237b-48e5-abe3-cab9be67456d', roletype : 'User', rolename : 'MarvinFake Role pquboudo6u', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : 'e7689683-98e4-4f45-8711-407951743827', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:45,137 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:45,137 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:45,161 - 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-27 14:51:45,161 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '14698441-237b-48e5-abe3-cab9be67456d', 'rule': 'list*', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'qe8kkA47MZeUoHXzfYH+fCXJHCs='}
2026-10-27 14:51:45,162 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:45,223 - DEBUG - Response : {id : 'b549cc5d-55ff-40f8-b15f-a2e2569f7c9c', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rule : 'list*', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:45,223 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '14698441-237b-48e5-abe3-cab9be67456d', 'rule': '*Vol*', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'XJH/jQxkwiZCQVE84aHta1+jtJA='}
2026-10-27 14:51:45,223 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:45,262 - DEBUG - Response : {id : 'efc5849f-f265-44f1-94f8-17c7c9ab0ade', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rule : '*Vol*', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:45,262 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '14698441-237b-48e5-abe3-cab9be67456d', 'rule': 'listCapabilities', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b't6kgptUMCHpqTwSzUEm+3ELtAg4='}
2026-10-27 14:51:45,263 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:45,315 - DEBUG - Response : {id : '82e9bd9a-cf7b-4005-9b6e-b8f64c516dee', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rule : 'listCapabilities', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:45,316 - DEBUG - Payload: {'roleid': '14698441-237b-48e5-abe3-cab9be67456d', 'ruleorder': '82e9bd9a-cf7b-4005-9b6e-b8f64c516dee,6ea2dac3-291f-4578-8a14-2dd7ec55abe4,b549cc5d-55ff-40f8-b15f-a2e2569f7c9c,efc5849f-f265-44f1-94f8-17c7c9ab0ade', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'z9JsoZf5IIJk8DUAgx1Y2+VT1zU='}
2026-10-27 14:51:45,316 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-27 14:51:45,347 - DEBUG - Response : {success : True}
2026-10-27 14:51:45,347 - DEBUG - Payload: {'roleid': '14698441-237b-48e5-abe3-cab9be67456d', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'vOyJZrk19+r8d73Uod+7qcPKRvk='}
2026-10-27 14:51:45,347 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:45,396 - DEBUG - Response : [{id : '82e9bd9a-cf7b-4005-9b6e-b8f64c516dee', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : 'listCapabilities', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '6ea2dac3-291f-4578-8a14-2dd7ec55abe4', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : 'b549cc5d-55ff-40f8-b15f-a2e2569f7c9c', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : 'list*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : 'efc5849f-f265-44f1-94f8-17c7c9ab0ade', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : '*Vol*', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-27 14:51:45,397 - DEBUG - Payload: {'roleid': '14698441-237b-48e5-abe3-cab9be67456d', 'ruleorder': '6ea2dac3-291f-4578-8a14-2dd7ec55abe4,b549cc5d-55ff-40f8-b15f-a2e2569f7c9c,efc5849f-f265-44f1-94f8-17c7c9ab0ade,82e9bd9a-cf7b-4005-9b6e-b8f64c516dee', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'SwPkR54NN40kGCrWRCHsCHzQy2c='}
2026-10-27 14:51:45,397 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-27 14:51:45,435 - DEBUG - Response : {success : True}
2026-10-27 14:51:45,435 - DEBUG - Payload: {'roleid': '14698441-237b-48e5-abe3-cab9be67456d', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'vOyJZrk19+r8d73Uod+7qcPKRvk='}
2026-10-27 14:51:45,436 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:45,451 - DEBUG - Response : [{id : '6ea2dac3-291f-4578-8a14-2dd7ec55abe4', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : 'b549cc5d-55ff-40f8-b15f-a2e2569f7c9c', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : 'list*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : 'efc5849f-f265-44f1-94f8-17c7c9ab0ade', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : '*Vol*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '82e9bd9a-cf7b-4005-9b6e-b8f64c516dee', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : 'listCapabilities', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-27 14:51:45,452 - DEBUG - Payload: {'roleid': '14698441-237b-48e5-abe3-cab9be67456d', 'ruleorder': '82e9bd9a-cf7b-4005-9b6e-b8f64c516dee,efc5849f-f265-44f1-94f8-17c7c9ab0ade,6ea2dac3-291f-4578-8a14-2dd7ec55abe4,b549cc5d-55ff-40f8-b15f-a2e2569f7c9c', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'poQJOjHOdJTXx4U5TsG5EPYbsVE='}
2026-10-27 14:51:45,452 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-27 14:51:45,496 - DEBUG - Response : {success : True}
2026-10-27 14:51:45,497 - DEBUG - Payload: {'roleid': '14698441-237b-48e5-abe3-cab9be67456d', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'vOyJZrk19+r8d73Uod+7qcPKRvk='}
2026-10-27 14:51:45,497 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:45,513 - DEBUG - Response : [{id : '82e9bd9a-cf7b-4005-9b6e-b8f64c516dee', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : 'listCapabilities', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : 'efc5849f-f265-44f1-94f8-17c7c9ab0ade', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : '*Vol*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '6ea2dac3-291f-4578-8a14-2dd7ec55abe4', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : 'b549cc5d-55ff-40f8-b15f-a2e2569f7c9c', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : 'list*', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-27 14:51:45,513 - DEBUG - Payload: {'roleid': '14698441-237b-48e5-abe3-cab9be67456d', 'ruleorder': 'b549cc5d-55ff-40f8-b15f-a2e2569f7c9c,6ea2dac3-291f-4578-8a14-2dd7ec55abe4,efc5849f-f265-44f1-94f8-17c7c9ab0ade,82e9bd9a-cf7b-4005-9b6e-b8f64c516dee', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'0g/k71dqWIseqaKbIrJgsx4DRBM='}
2026-10-27 14:51:45,514 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-27 14:51:45,539 - DEBUG - Response : {success : True}
2026-10-27 14:51:45,539 - DEBUG - Payload: {'roleid': '14698441-237b-48e5-abe3-cab9be67456d', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'vOyJZrk19+r8d73Uod+7qcPKRvk='}
2026-10-27 14:51:45,539 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:45,556 - DEBUG - Response : [{id : 'b549cc5d-55ff-40f8-b15f-a2e2569f7c9c', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : 'list*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '6ea2dac3-291f-4578-8a14-2dd7ec55abe4', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : 'efc5849f-f265-44f1-94f8-17c7c9ab0ade', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : '*Vol*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '82e9bd9a-cf7b-4005-9b6e-b8f64c516dee', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : 'listCapabilities', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-27 14:51:45,557 - DEBUG - Payload: {'roleid': '14698441-237b-48e5-abe3-cab9be67456d', 'ruleorder': 'b549cc5d-55ff-40f8-b15f-a2e2569f7c9c,efc5849f-f265-44f1-94f8-17c7c9ab0ade,82e9bd9a-cf7b-4005-9b6e-b8f64c516dee,6ea2dac3-291f-4578-8a14-2dd7ec55abe4', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ljvbBXI1VtG5CNF9I/+0hfPniMs='}
2026-10-27 14:51:45,557 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-27 14:51:45,600 - DEBUG - Response : {success : True}
2026-10-27 14:51:45,601 - DEBUG - Payload: {'roleid': '14698441-237b-48e5-abe3-cab9be67456d', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'vOyJZrk19+r8d73Uod+7qcPKRvk='}
2026-10-27 14:51:45,601 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:45,617 - DEBUG - Response : [{id : 'b549cc5d-55ff-40f8-b15f-a2e2569f7c9c', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : 'list*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : 'efc5849f-f265-44f1-94f8-17c7c9ab0ade', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : '*Vol*', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '82e9bd9a-cf7b-4005-9b6e-b8f64c516dee', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : 'listCapabilities', permission : 'allow', description : 'Fake role permission created by Marvin test'}, {id : '6ea2dac3-291f-4578-8a14-2dd7ec55abe4', roleid : '14698441-237b-48e5-abe3-cab9be67456d', rolename : 'MarvinFake Role pquboudo6u', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-27 14:51:45,618 - DEBUG - Payload: {'id': 'e7689683-98e4-4f45-8711-407951743827', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Ht8pKNUFJNYVoiPzTuHqxd8hTjM='}
2026-10-27 14:51:45,618 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:45,668 - DEBUG - === Jobid: 2b62a393-bb6b-4e34-9462-7555f8c475fd Started ===
2026-10-27 14:51:45,669 - DEBUG - Payload: {'jobid': '2b62a393-bb6b-4e34-9462-7555f8c475fd', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'48W6s7QYfPN0mqvL9IbnseAesOQ='}
2026-10-27 14:51:45,669 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:45,704 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'e7689683-98e4-4f45-8711-407951743827', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:46+0000', jobid : '2b62a393-bb6b-4e34-9462-7555f8c475fd', jobstatus : 0}
2026-10-27 14:51:46,705 - DEBUG - === JobId:2b62a393-bb6b-4e34-9462-7555f8c475fd is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:46,706 - DEBUG - Payload: {'jobid': '2b62a393-bb6b-4e34-9462-7555f8c475fd', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'48W6s7QYfPN0mqvL9IbnseAesOQ='}
2026-10-27 14:51:46,706 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:46,730 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'e7689683-98e4-4f45-8711-407951743827', created : '2026-10-27T14:51:46+0000', completed : '2026-10-27T14:51:46+0000', jobid : '2b62a393-bb6b-4e34-9462-7555f8c475fd', jobstatus : 1}
2026-10-27 14:51:46,730 - DEBUG - ===Jobid:2b62a393-bb6b-4e34-9462-7555f8c475fd ; StartTime:Tue Oct 27 14:51:45 2026 ; EndTime:Tue Oct 27 14:51:46 2026 ; TotalTime:-1===
2026-10-27 14:51:46,730 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'e7689683-98e4-4f45-8711-407951743827', created : '2026-10-27T14:51:46+0000', completed : '2026-10-27T14:51:46+0000', jobid : '2b62a393-bb6b-4e34-9462-7555f8c475fd', jobstatus : 1}
2026-10-27 14:51:46,731 - DEBUG - Payload: {'id': '6ea2dac3-291f-4578-8a14-2dd7ec55abe4', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'YANWhTaKcrTtIhhIV+8PXhvPunw='}
2026-10-27 14:51:46,731 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:46,760 - DEBUG - Response : {success : True}
2026-10-27 14:51:46,761 - DEBUG - Payload: {'id': '14698441-237b-48e5-abe3-cab9be67456d', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'VOKy0VRe1D2KT01dQAcqge3Qloo='}
2026-10-27 14:51:46,761 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:46,791 - DEBUG - Response : {success : True}
2026-10-27 14:51:46,792 - DEBUG - Payload: {'id': 'b549cc5d-55ff-40f8-b15f-a2e2569f7c9c', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'wMKHA10flBsBC0wd57d5qpkX4lE='}
2026-10-27 14:51:46,792 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:46,805 - 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=b549cc5d-55ff-40f8-b15f-a2e2569f7c9c 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=b549cc5d-55ff-40f8-b15f-a2e2569f7c9c 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-27 14:51:46,806 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.deleteRolePermission.deleteRolePermissionCmd object at 0x7f8d653f6340> 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=b549cc5d-55ff-40f8-b15f-a2e2569f7c9c 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=b549cc5d-55ff-40f8-b15f-a2e2569f7c9c 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-27 14:51:46,806 - 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=b549cc5d-55ff-40f8-b15f-a2e2569f7c9c 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-27 14:51:46,806 - DEBUG - TestCaseName: test_rolepermission_lifecycle_update; Time Taken: 2 Seconds; StartTime: Tue Oct 27 14:51:44 2026; EndTime: Tue Oct 27 14:51:46 2026; Result: SUCCESS
2026-10-27 14:51:46,807 - DEBUG - ::::::::::::STARTED : TC: test_rolepermission_lifecycle_update_permission :::::::::::
2026-10-27 14:51:46,807 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:46,807 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:46,829 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:46,830 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role bxv18dfvqe', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'jeW8htLq00qR7WzqUQMOP2fqSaY='}
2026-10-27 14:51:46,830 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:46,864 - DEBUG - Response : {type : 'User', state : 'enabled', id : '8d89dd6b-aa87-4e4e-a486-faa42bfe9e4b', name : 'MarvinFake Role bxv18dfvqe', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:46,864 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': '8d89dd6b-aa87-4e4e-a486-faa42bfe9e4b', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'RWa4RfyMHxC12Fi0Fnj82UWbCYA='}
2026-10-27 14:51:46,865 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:46,896 - DEBUG - Response : {id : '42ae6d66-3297-4a1a-ba84-a826980edde1', roleid : '8d89dd6b-aa87-4e4e-a486-faa42bfe9e4b', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:46,897 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': '8d89dd6b-aa87-4e4e-a486-faa42bfe9e4b', 'username': 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission-8T6DEC', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'63HtB1eyneQwuqm91VCPInfwrqk='}
2026-10-27 14:51:46,897 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:47,824 - DEBUG - Response : {id : 'd24d6bb3-03b2-4b7c-a673-a373f96e447c', name : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission-8T6DEC', accounttype : 0, roleid : '8d89dd6b-aa87-4e4e-a486-faa42bfe9e4b', roletype : 'User', rolename : 'MarvinFake Role bxv18dfvqe', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:47+0000', user : [{id : '58d99cb0-e43d-4aab-bca7-926f15f54342', username : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission-8T6DEC', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:48+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission-8T6DEC', accounttype : 0, usersource : 'native', roleid : '8d89dd6b-aa87-4e4e-a486-faa42bfe9e4b', roletype : 'User', rolename : 'MarvinFake Role bxv18dfvqe', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : 'd24d6bb3-03b2-4b7c-a673-a373f96e447c', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:47,825 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:47,825 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:47,844 - 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-27 14:51:47,845 - DEBUG - Payload: {'permission': 'deny', 'roleid': '8d89dd6b-aa87-4e4e-a486-faa42bfe9e4b', 'ruleid': '42ae6d66-3297-4a1a-ba84-a826980edde1', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'BUc9UdJ2nkRf4Bw1CZ7YAybSc7A='}
2026-10-27 14:51:47,845 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-27 14:51:47,869 - DEBUG - Response : {success : True}
2026-10-27 14:51:47,871 - DEBUG - Payload: {'roleid': '8d89dd6b-aa87-4e4e-a486-faa42bfe9e4b', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'sbPtbPep1PdHt5RZQEnxWQ+DJ2A='}
2026-10-27 14:51:47,871 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:47,899 - DEBUG - Response : [{id : '42ae6d66-3297-4a1a-ba84-a826980edde1', roleid : '8d89dd6b-aa87-4e4e-a486-faa42bfe9e4b', rolename : 'MarvinFake Role bxv18dfvqe', rule : 'listVirtualMachines', permission : 'deny', description : 'Fake role permission created by Marvin test'}]
2026-10-27 14:51:47,900 - DEBUG - Payload: {'permission': 'allow', 'roleid': '8d89dd6b-aa87-4e4e-a486-faa42bfe9e4b', 'ruleid': '42ae6d66-3297-4a1a-ba84-a826980edde1', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'EHs89xpyAXaUHyYRYyyXz9kxQhY='}
2026-10-27 14:51:47,900 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-27 14:51:47,923 - DEBUG - Response : {success : True}
2026-10-27 14:51:47,924 - DEBUG - Payload: {'roleid': '8d89dd6b-aa87-4e4e-a486-faa42bfe9e4b', 'command': 'listRolePermissions', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'sbPtbPep1PdHt5RZQEnxWQ+DJ2A='}
2026-10-27 14:51:47,924 - DEBUG - ========Sending GET Cmd : listRolePermissions=======
2026-10-27 14:51:47,942 - DEBUG - Response : [{id : '42ae6d66-3297-4a1a-ba84-a826980edde1', roleid : '8d89dd6b-aa87-4e4e-a486-faa42bfe9e4b', rolename : 'MarvinFake Role bxv18dfvqe', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}]
2026-10-27 14:51:47,944 - DEBUG - Payload: {'id': 'd24d6bb3-03b2-4b7c-a673-a373f96e447c', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'tSbf3Pj9wRaqrxqTjElfMg0UbSQ='}
2026-10-27 14:51:47,944 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:47,983 - DEBUG - === Jobid: 530189b7-affe-4bee-ab89-6e21488d6998 Started ===
2026-10-27 14:51:47,984 - DEBUG - Payload: {'jobid': '530189b7-affe-4bee-ab89-6e21488d6998', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'CivUPyO/QQs1LfhywQSBqOJpl6g='}
2026-10-27 14:51:47,984 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:48,003 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'd24d6bb3-03b2-4b7c-a673-a373f96e447c', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:48+0000', jobid : '530189b7-affe-4bee-ab89-6e21488d6998', jobstatus : 0}
2026-10-27 14:51:49,005 - DEBUG - === JobId:530189b7-affe-4bee-ab89-6e21488d6998 is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:49,005 - DEBUG - Payload: {'jobid': '530189b7-affe-4bee-ab89-6e21488d6998', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'CivUPyO/QQs1LfhywQSBqOJpl6g='}
2026-10-27 14:51:49,005 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:49,067 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'd24d6bb3-03b2-4b7c-a673-a373f96e447c', created : '2026-10-27T14:51:48+0000', completed : '2026-10-27T14:51:48+0000', jobid : '530189b7-affe-4bee-ab89-6e21488d6998', jobstatus : 1}
2026-10-27 14:51:49,068 - DEBUG - ===Jobid:530189b7-affe-4bee-ab89-6e21488d6998 ; StartTime:Tue Oct 27 14:51:47 2026 ; EndTime:Tue Oct 27 14:51:49 2026 ; TotalTime:-1===
2026-10-27 14:51:49,068 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'd24d6bb3-03b2-4b7c-a673-a373f96e447c', created : '2026-10-27T14:51:48+0000', completed : '2026-10-27T14:51:48+0000', jobid : '530189b7-affe-4bee-ab89-6e21488d6998', jobstatus : 1}
2026-10-27 14:51:49,068 - DEBUG - Payload: {'id': '42ae6d66-3297-4a1a-ba84-a826980edde1', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'anjh5nghVW9L9CXzbPWs09w67rw='}
2026-10-27 14:51:49,069 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:49,104 - DEBUG - Response : {success : True}
2026-10-27 14:51:49,104 - DEBUG - Payload: {'id': '8d89dd6b-aa87-4e4e-a486-faa42bfe9e4b', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'pZ1e+QOQdUSW/f/9Cidtw5QQYrU='}
2026-10-27 14:51:49,105 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:49,135 - DEBUG - Response : {success : True}
2026-10-27 14:51:49,136 - DEBUG - TestCaseName: test_rolepermission_lifecycle_update_permission; Time Taken: 2 Seconds; StartTime: Tue Oct 27 14:51:46 2026; EndTime: Tue Oct 27 14:51:49 2026; Result: SUCCESS
2026-10-27 14:51:49,137 - DEBUG - ::::::::::::STARTED : TC: test_rolepermission_lifecycle_update_permission_negative :::::::::::
2026-10-27 14:51:49,137 - DEBUG - Payload: {'command': 'listCapabilities', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'AVSz+2elvktJpTINZka8QKi8StQ='}
2026-10-27 14:51:49,137 - DEBUG - ========Sending GET Cmd : listCapabilities=======
2026-10-27 14:51:49,204 - DEBUG - Response : {securitygroupsenabled : False, dynamicrolesenabled : True, cloudstackversion : '24.0.0-shapeblue20748', 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-27 14:51:49,204 - DEBUG - Payload: {'description': 'Fake Role created by Marvin test', 'name': 'MarvinFake Role tmrd95qqac', 'type': 'User', 'command': 'createRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'1cMOBPv/a4WwkabEj4zvbFKPad4='}
2026-10-27 14:51:49,204 - DEBUG - ========Sending GET Cmd : createRole=======
2026-10-27 14:51:49,232 - DEBUG - Response : {type : 'User', state : 'enabled', id : 'ff345428-4711-448f-9087-305328d63218', name : 'MarvinFake Role tmrd95qqac', description : 'Fake Role created by Marvin test', ispublic : True}
2026-10-27 14:51:49,232 - DEBUG - Payload: {'description': 'Fake role permission created by Marvin test', 'permission': 'allow', 'roleid': 'ff345428-4711-448f-9087-305328d63218', 'rule': 'listVirtualMachines', 'command': 'createRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'A79bJCiK7YrjrbmJOfkXu7yapyA='}
2026-10-27 14:51:49,232 - DEBUG - ========Sending GET Cmd : createRolePermission=======
2026-10-27 14:51:49,263 - DEBUG - Response : {id : '75f6c963-6da4-4cce-bb87-8892ffdf313d', roleid : 'ff345428-4711-448f-9087-305328d63218', rule : 'listVirtualMachines', permission : 'allow', description : 'Fake role permission created by Marvin test'}
2026-10-27 14:51:49,264 - DEBUG - Payload: {'accounttype': 0, 'email': 'mtu@test.cloud', 'firstname': 'Marvin', 'lastname': 'TestUser', 'password': 'password', 'roleid': 'ff345428-4711-448f-9087-305328d63218', 'username': 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission_negative-UPDOMU', 'command': 'createAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'7QL81h3xRxGKN+nvIF6dU+OBVYo='}
2026-10-27 14:51:49,264 - DEBUG - ========Sending GET Cmd : createAccount=======
2026-10-27 14:51:50,133 - DEBUG - Response : {id : 'dcba451b-073c-4557-9879-0283e366e28f', name : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission_negative-UPDOMU', accounttype : 0, roleid : 'ff345428-4711-448f-9087-305328d63218', roletype : 'User', rolename : 'MarvinFake Role tmrd95qqac', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', 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-27T14:51:50+0000', user : [{id : '097a3dc6-93f9-43e7-8b02-5ac2a6e7f8b7', username : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission_negative-UPDOMU', firstname : 'Marvin', lastname : 'TestUser', email : 'mtu@test.cloud', created : '2026-10-27T14:51:50+0000', state : 'enabled', account : 'rolete-TestDynamicRoles-test_rolepermission_lifecycle_update_permission_negative-UPDOMU', accounttype : 0, usersource : 'native', roleid : 'ff345428-4711-448f-9087-305328d63218', roletype : 'User', rolename : 'MarvinFake Role tmrd95qqac', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domain : 'ROOT', accountid : 'dcba451b-073c-4557-9879-0283e366e28f', iscallerchilddomain : False, isdefault : False, is2faenabled : False, is2famandated : False}], isdefault : False, groups : [], apikeyaccess : 'INHERIT'}
2026-10-27 14:51:50,134 - DEBUG - Payload: {'name': 'dynamic.apichecker.cache.period', 'command': 'listConfigurations', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'mmI2L52QUM1/6xb/LkC8N6lgq5Q='}
2026-10-27 14:51:50,134 - DEBUG - ========Sending GET Cmd : listConfigurations=======
2026-10-27 14:51:50,156 - 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-27 14:51:50,157 - DEBUG - Payload: {'permission': 'some_other_value', 'roleid': 'ff345428-4711-448f-9087-305328d63218', 'ruleid': '75f6c963-6da4-4cce-bb87-8892ffdf313d', 'command': 'updateRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'4ah1XUMkJb6+m9Y1kxlo2jldHII='}
2026-10-27 14:51:50,157 - DEBUG - ========Sending GET Cmd : updateRolePermission=======
2026-10-27 14:51:50,177 - 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-27 14:51:50,178 - ERROR - marvinRequest : CmdName: <marvin.cloudstackAPI.updateRolePermission.updateRolePermissionCmd object at 0x7f8d653f69d0> 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-27 14:51:50,178 - DEBUG - Payload: {'id': 'dcba451b-073c-4557-9879-0283e366e28f', 'command': 'deleteAccount', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'x2cI7KWWxWDJDVpu0ngxRv04jMY='}
2026-10-27 14:51:50,178 - DEBUG - ========Sending GET Cmd : deleteAccount=======
2026-10-27 14:51:50,213 - DEBUG - === Jobid: ea8f2b08-cf72-4e7f-95b5-ca79aea13bd1 Started ===
2026-10-27 14:51:50,213 - DEBUG - Payload: {'jobid': 'ea8f2b08-cf72-4e7f-95b5-ca79aea13bd1', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ktJWLNT5K+v65Zo96jr+R+XQ+kU='}
2026-10-27 14:51:50,213 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:50,239 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobinstancetype : 'Account', jobinstanceid : 'dcba451b-073c-4557-9879-0283e366e28f', managementserverid : 'cdce5814-bb52-42f8-9ce6-85d2cdb65e27', managementservername : 'pr14320-n151-kvm-ubuntu26-mgmt1.sofia.shapeblue.com', created : '2026-10-27T14:51:50+0000', jobid : 'ea8f2b08-cf72-4e7f-95b5-ca79aea13bd1', jobstatus : 0}
2026-10-27 14:51:51,241 - DEBUG - === JobId:ea8f2b08-cf72-4e7f-95b5-ca79aea13bd1 is Still Processing, Will TimeOut in:3599 ====
2026-10-27 14:51:51,241 - DEBUG - Payload: {'jobid': 'ea8f2b08-cf72-4e7f-95b5-ca79aea13bd1', 'command': 'queryAsyncJobResult', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'ktJWLNT5K+v65Zo96jr+R+XQ+kU='}
2026-10-27 14:51:51,241 - DEBUG - ========Sending GET Cmd : queryAsyncJobResult=======
2026-10-27 14:51:51,266 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'dcba451b-073c-4557-9879-0283e366e28f', created : '2026-10-27T14:51:50+0000', completed : '2026-10-27T14:51:50+0000', jobid : 'ea8f2b08-cf72-4e7f-95b5-ca79aea13bd1', jobstatus : 1}
2026-10-27 14:51:51,267 - DEBUG - ===Jobid:ea8f2b08-cf72-4e7f-95b5-ca79aea13bd1 ; StartTime:Tue Oct 27 14:51:50 2026 ; EndTime:Tue Oct 27 14:51:51 2026 ; TotalTime:-1===
2026-10-27 14:51:51,267 - DEBUG - Response : {accountid : 'c1154605-d1fe-11f1-81aa-1e0044000301', account : 'admin', domainid : '54e5326a-d1fe-11f1-81aa-1e0044000301', domainpath : 'ROOT', userid : 'c1166b9d-d1fe-11f1-81aa-1e0044000301', cmd : 'org.apache.cloudstack.api.command.admin.account.DeleteAccountCmd', jobprocstatus : 0, jobresultcode : 0, jobresulttype : 'object', jobresult : {success : True}, jobinstancetype : 'Account', jobinstanceid : 'dcba451b-073c-4557-9879-0283e366e28f', created : '2026-10-27T14:51:50+0000', completed : '2026-10-27T14:51:50+0000', jobid : 'ea8f2b08-cf72-4e7f-95b5-ca79aea13bd1', jobstatus : 1}
2026-10-27 14:51:51,267 - DEBUG - Payload: {'id': '75f6c963-6da4-4cce-bb87-8892ffdf313d', 'command': 'deleteRolePermission', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'i8TReN059j0O5KHnr9dnJhsliMc='}
2026-10-27 14:51:51,267 - DEBUG - ========Sending GET Cmd : deleteRolePermission=======
2026-10-27 14:51:51,298 - DEBUG - Response : {success : True}
2026-10-27 14:51:51,298 - DEBUG - Payload: {'id': 'ff345428-4711-448f-9087-305328d63218', 'command': 'deleteRole', 'response': 'json', 'apiKey': 'LIN6rqXuaJwMPfGYFh13qDwYz5VNNz1J2J6qIOWcd3oLQOq0WtD4CwRundBL6rzXToa3lQOC_vKjI3nkHtiD8Q', 'signature': b'Vf72FLAgBwiU8EEgL/9SxpZi3HY='}
2026-10-27 14:51:51,298 - DEBUG - ========Sending GET Cmd : deleteRole=======
2026-10-27 14:51:51,328 - DEBUG - Response : {success : True}
2026-10-27 14:51:51,329 - DEBUG - TestCaseName: test_rolepermission_lifecycle_update_permission_negative; Time Taken: 2 Seconds; StartTime: Tue Oct 27 14:51:49 2026; EndTime: Tue Oct 27 14:51:51 2026; Result: SUCCESS
2026-10-27 14:51:51,329 - DEBUG - Cleaning up the resources
